A custom spacemacs configuration layer for using
https://github.com/org-roam/org-roam
First, clone the source code to the private directly.
# Clone with SSH
git clone git@github.com:joshmedeski/org-roam-spacemacs-layer.git ~/.emacs.d/private/org-roam
# Clone with HTTPS
git clone https://github.com/joshmedeski/org-roam-spacemacs-layer.git ~/.emacs.d/private/org-roam
Add org-roam
to the dotspacemacs-configuration-layers
list
dotspacemacs-configuration-layers
'(
org-roam
;; ...other layers
)
Then restart spacemacs (SPC q r
). When it restarts org-roam
and all its dependencies will be installed.
All commands are bound to SPC a r
Key Binding | Command | Description |
---|---|---|
SPC a r r | org-roam-find-file | Search all roam files |
SPC a r c | org-roam-capture | Capture roam entry |
SPC a r b | org-roam-switch-to-buffer | Search all open roam files |
SPC a r t | org-roam-today | Open the roam entry for today |
SPC a r T | org-roam-toomorrow | Open the roam entry for tomorrow |
SPC a r y | org-roam-yesterday-today | Open the roam entry for yesterday |
TODO SPC a r w | org-roam-weeklies-week | Open the roam entry for this week |
TODO SPC a r m | org-roam-weeklies-month | Open the roam entry for this month |
All commands are bound to SPC m
or ~,~.
Key Binding | Command | Description |
---|---|---|
SPC m F | org-roam-find-file | Display prompt to find a roam file |
SPC m g | org-roam-graph | Displays roam graph |
SPC m i r | org-roam-insert | Insert link to roam file |
SPC m r | org-roam | Toggles org-roam mode |
SPC m u | org-roam-unlinked-references | Displays potential references for |
the active file |
Started from https://org-roam.readthedocs.io/en/master/installation/#spacemacs