-
-
Notifications
You must be signed in to change notification settings - Fork 47
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Updated readme to include installation + configuration instructions for vanilla spacemacs #155
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -157,18 +157,60 @@ the file manually. | |
|
||
### Spacemacs | ||
|
||
Most probably you already have a private `org-roam` layer, if not, see examples | ||
From version 0.300.0, Spacemacs offers support for `org-roam`. This means private layers are no longer necessary. | ||
If you have already configured `org-ref`, you can follow this [blog post](https://philipperambert.com/Installing-Org-Roam-Bibtex-In-Spacemacs). | ||
|
||
Inside the function `(defun dotspacemacs/layers () ... )` uncomment the org layer and switch on roam-support. | ||
You will also need to enable `bibtex`. | ||
You should have something that looks like: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It should be explicitly stated that we are handling dependencies here. |
||
```el | ||
(defun dotspacemacs/layers () | ||
;;Your custom config goes here | ||
org | ||
(org :variables | ||
org-enable-roam-support t) | ||
bibtex | ||
) | ||
``` | ||
|
||
Add `org-roam-bibtex` to `dotspacemacs-additional-packages`: | ||
```el | ||
dotspacemacs-additional-packages '(... org-roam-bibtex ...) | ||
``` | ||
|
||
|
||
Inside the function `(defun dotspacemacs/user-config () ... )` set the custom variables and add a hook to org-mode so that org-roam-mode gets automatically enabled with the opening of an org file | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm not sure we need instructions for Org Roam in ORB's README. A link would be enough. |
||
|
||
Configure `org-roam` | ||
```el | ||
(setq org-roam-directory "~/path/to/roam") | ||
(setq org-roam-db-location "~/path/to/roam/org-roam.db") | ||
(add-hook 'org-mode-hook 'org-roam-mode) | ||
``` | ||
Configure `org-roam-bibtex` to enable `org-roam-bibtex-mode` when org files are loaded | ||
|
||
```el | ||
(use-package org-roam-bibtex | ||
:after org-roam | ||
:hook (org-roam-mode . org-roam-bibtex-mode)) | ||
``` | ||
Configure `org-ref` to use your custom `.bib` file. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The same applies to bibtex-completion. |
||
```el | ||
(setq bibtex-completion-bibliography | ||
'("~/path/to/bibfile.bib")) | ||
``` | ||
|
||
If you are running an older version of spacemacs or don't want to stop using your private `org-roam` layer, (see examples | ||
[here](https://org-roam.discourse.group/t/orb-helm-bibtex-open-notes-wont-create-new-note/690) | ||
and | ||
[here](https://www.reddit.com/r/emacs/comments/f6erh0/total_noob_how_do_i_install_orgroam_in_spacemacs/). | ||
Add `org-roam-bibtex` to `org-roam-packages`: | ||
[here](https://www.reddit.com/r/emacs/comments/f6erh0/total_noob_how_do_i_install_orgroam_in_spacemacs/) ), | ||
add `org-roam-bibtex` to `org-roam-packages`: | ||
|
||
``` el | ||
(defconst org-roam-packages | ||
'(org-roam org-roam-bibtex)) | ||
|
||
``` | ||
|
||
add this after `org-roam/init-org-roam`: | ||
|
||
``` el | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the blog post should be explicitly credited as the source of information.