Files
org-roam/doc/tour.md
2020-02-12 19:05:19 +08:00

21 lines
727 B
Markdown

### A Tour of Org-Roam
All of this starts from the note. A note is just a simple `.org` file
in the directory. Any org file in the directory is considered part of
the org-roam ecosystem. Notes are quickly linked together (and created
if necessary) using `org-roam-insert`.
![org-roam-insert](images/org-roam-insert.gif)
Org-roam tracks all of these file links, and builds a cache
asynchronously in the background. This cache is used to populate the
backlinks buffer, which shows files that link to the current file, as
well as some preview contents:
![org-roam-buffer](images/org-roam-buffer.gif)
These file links also form a graph. The generated graph is navigable
in Emacs.
![org-roam-graph](images/org-roam-graph.gif)