Updated readme to include installation + configuration instructions for vanilla spacemacs #155
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Included installation and configuration instructions for org-roam + org-roam-bibtex for a vanilla spacemacs install.
Updated README
myshevchuk
requested changes
Jan 11, 2021
| @@ -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). | |||
There was a problem hiding this comment.
I think the blog post should be explicitly credited as the source of information.
| ``` | ||
|
|
||
|
|
||
| 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.
I'm not sure we need instructions for Org Roam in ORB's README. A link would be enough.
| :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.
The same applies to bibtex-completion.
|
|
||
| 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.
It should be explicitly stated that we are handling dependencies here.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The extra instructions might be split between org-roam and org-roam-bibtex to keep the latter README more manageable. However, I think it is much more useful to have all these instructions in one place.