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

Merge branch 'master' into v2

Browse Source 
* master:
  (doc): Add file-truename to set org-roam-directory (README and documentation) (#1487)
This commit is contained in:
Jethro Kuan
2021-04-28 13:45:23 +08:00
parent 22c8d1032b 15c1a46e41
commit dd7c3fab23
2 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@@ -47,7 +47,7 @@ Here's a sample configuration with `use-package`:
:hook
(after-init . org-roam-mode)
:custom
(org-roam-directory "/path/to/org-files/")
(org-roam-directory (file-truename "/path/to/org-files/"))
:bind (:map org-roam-mode-map
(("C-c n l" . org-roam)
("C-c n f" . org-roam-find-file)
@@ -56,6 +56,9 @@ Here's a sample configuration with `use-package`:
(("C-c n i" . org-roam-insert))))
```
The `file-truename` function is only necessary when you use symbolic links
inside `org-roam-directory`: Org-roam does not resolve symbolic links.
Org-roam requires sqlite to function. Org-roam optionally uses Graphviz for
graph-related functionality. It is recommended to install PCRE-enabled ripgrep
for better performance and extended functionality.

5
doc/org-roam.org
View File

@@ -361,9 +361,12 @@ For this tutorial, create an empty directory, and set ~org-roam-directory~:
#+BEGIN_SRC emacs-lisp
(make-directory "~/org-roam")
(setq org-roam-directory "~/org-roam")
(setq org-roam-directory (file-truename "~/org-roam"))
#+END_SRC
The ~file-truename~ function is only necessary when you use symbolic links
inside ~org-roam-directory~: Org-roam does not resolve symbolic links.
Next, we setup Org-roam to run functions on file changes to maintain cache
consistency. This is achieved by running ~M-x org-roam-setup~. To ensure that
Org-roam is available on startup, place this in your Emacs configuration: