Skip to content
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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

oliver-sandberg
Copy link

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.

Included installation and configuration instructions for org-roam + org-roam-bibtex for a vanilla spacemacs install.
@@ -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).
Copy link
Member

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.

```


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
Copy link
Member

Choose a reason for hiding this comment

The 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.

:after org-roam
:hook (org-roam-mode . org-roam-bibtex-mode))
```
Configure `org-ref` to use your custom `.bib` file.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants