mirror of
https://github.com/org-roam/org-roam
synced 2025-08-25 14:13:30 -05:00
(docs): add Doom Emacs installation instructions (#212)
This commit is contained in:
@@ -88,3 +88,33 @@ If you are using Spacemacs, you can easily install org-roam by creating a simple
|
|||||||
```
|
```
|
||||||
|
|
||||||
Next, append `org-roam` to the `dotspacemacs-configuration-layers` list in your `.spacemacs` configuration file. Reload (`SPC f e R`) or restart Emacs to load `org-roam`. It's functions are available under the prefix `SPC a r` and `, r` when visiting an org-mode buffer.
|
Next, append `org-roam` to the `dotspacemacs-configuration-layers` list in your `.spacemacs` configuration file. Reload (`SPC f e R`) or restart Emacs to load `org-roam`. It's functions are available under the prefix `SPC a r` and `, r` when visiting an org-mode buffer.
|
||||||
|
|
||||||
|
## Doom Emacs
|
||||||
|
|
||||||
|
If you are using [Doom Emacs](https://github.com/hlissner/doom-emacs), configure packages as explained in the [getting started](https://github.com/hlissner/doom-emacs/blob/develop/docs/getting_started.org#configuring-packages) guide.
|
||||||
|
|
||||||
|
Declare org-roam as a package in your `~/.doom.d/packages.el`:
|
||||||
|
|
||||||
|
```elisp
|
||||||
|
;; ~/.doom.d/packages.el
|
||||||
|
|
||||||
|
(package! org-roam
|
||||||
|
:recipe (:host github :repo "jethrokuan/org-roam" :branch "develop"))
|
||||||
|
```
|
||||||
|
|
||||||
|
Subsequently, in your `~/.doom.d/config.el` file, configure org-roam:
|
||||||
|
|
||||||
|
```elisp
|
||||||
|
;; ~/.doom.d/config.el
|
||||||
|
(use-package! org-roam
|
||||||
|
:commands (org-roam-insert org-roam-find-file org-roam)
|
||||||
|
:init
|
||||||
|
(setq org-roam-directory "/path/to/org-files/")
|
||||||
|
(map! :leader
|
||||||
|
:prefix "n"
|
||||||
|
:desc "Org-Roam-Insert" "i" #'org-roam-insert
|
||||||
|
:desc "Org-Roam-Find" "/" #'org-roam-find-file
|
||||||
|
:desc "Org-Roam-Buffer" "r" #'org-roam)
|
||||||
|
:config
|
||||||
|
(org-roam-mode +1))
|
||||||
|
```
|
||||||
|
Reference in New Issue
Block a user