Add usage info for package description
[org-bookmarks.git] / README.org
bloba1e24536848f4b23995bddac6729bb19699f0f99
1 * Usage
3 =[M-x org-bookmarks]=
5 * The bookmarks Org mode file format
7 A bookmark entry in the bookmarks file requires three elements:
9 - headline is the bookmark title
10 - a tag "bookmark" to mark the headline as a bookmark
11 - the bookmark entry need to have a property "URL" with URL value
13 For example:
15 #+begin_src org
16 ,* Emacs
18 ,** /r/emacs                                                   :Reddit:bookmark:
19 :PROPERTIES:
20 :URL:      https://www.reddit.com/r/emacs
21 :DATE:     [2024-02-26 Mon 19:31]
22 :END:
24 ,** /r/planetemacs                                             :Reddit:bookmark:
25 :PROPERTIES:
26 :URL:      https://www.reddit.com/r/planetemacs/
27 :DATE:     [2024-02-26 Mon 19:37]
28 :END:
30 #+end_src