awesome-emacs/org-roam
1
0
Fork 0
mirror of https://github.com/org-roam/org-roam synced 2025-09-18 16:06:49 -05:00
Code Issues Packages Projects Releases Wiki Activity

(feature): use sqlite as backing database (#200)

Browse Source 
All org-roam related information will now be stored in the database. Henceforth, the cache needs to be built synchronously once (via `M-x org-roam-build-cache`), which is then incrementally updated.
This commit is contained in:
Jethro Kuan
2020-02-29 15:56:08 +08:00
committed by GitHub
parent d086d1675d
commit 0c2aaad3df
25 changed files with 738 additions and 839 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
doc/configuration.md
View File

@@ -35,9 +35,12 @@ Here is an example `.dir-locals.el` file that would be placed in a
second Org-roam directory.
```emacs-lisp
((nil . ((eval . (setq-local org-roam-directory (locate-dominating-file default-directory ".dir-locals.el"))))))
((nil . ((org-roam-directory . "/path/to/here/"))))
```
Remember to run `org-roam-build-cache` from a file within that
directory, at least once.
## Org-roam Buffer
The Org-roam buffer defaults to popping up from the right. You may

12
doc/tour.md
View File

@@ -13,13 +13,11 @@ Without further ado, let's begin!
## Building the Cache
Assuming you've set `org-roam-directory` appropriately, running `M-x
org-roam--build-cache-async` should build up the caches that will
allow you to begin using Org-roam. I do this on startup:
```emacs-lisp
(add-hook 'after-init-hook 'org-roam--build-cache-async)
```
The cache is a sqlite database named `org-roam.db`, which resides at
the root of your `org-roam-directory`. To begin, we need to do a first
build of this cache. To do so, run `M-x org-roam-build-cache`. This
may take a while the first time, but is generally instantaneous in
subsequent runs.
## Finding a Note