/spacemacs-org-roam

A spacemacs layer to support org-roam

Primary LanguageEmacs LispGNU General Public License v3.0GPL-3.0

Org-Roam layer

Description

This is a layer for spacemacs to support org-roam and other note taking projects in the ecosystem.

Features:

  • org-roam-bibtex
  • org-noter
  • org-fc

Installation

This package depends on the develop version of spacemacs. As the last stable release was Jan 2018, I recommend using develop anyway.

First, clone the spacemacs-org-roam repo to ~/.emacs.d/private/org-roam.

Then, you must clone org-fc to the directory local/org-fc (in full ~/.emacs.d/private/org-roam/local/org-fc).

Then, add it to your .spacemacs configuration-layers with (using your notes directory):

(setq dotspacemacs-configuration-layers '(
  (org-roam :variables
            org-roam-directory "/data/notes/orgRoam"
            org-fc-directories '("/data/notes/orgRoam"))))

You may also want to add additional variables to your org layer such as:

(setq dotspacemacs-configuration-layers '(
   (org :variables
        org-enable-roam-support t
        org-want-todo-bindings t
        org-want-todo-bindings t
        org-enable-org-journal-support t
        org-journal-date-prefix "#+TITLE: "
        org-journal-file-format "%Y-%m-%d.org"
        org-journal-dir "/data/notes/orgRoam/journal/"
        org-journal-date-format "%A, %d %B %Y"
        org-extend-today-until 5
        org-download-image-dir "/data/notes/orgRoam/downloads"
        org-ref-default-bibliography '("/data/notes/orgRoam/papers/references.bib")
        org-agenda-files '("/data/notes/orgRoam/agenda.org")
        org-journal-enable-agenda-integration t
        org-ref-pdf-directory "/data/notes/orgRoam/papers/pdfs/")))
   (org-roam :variables
             org-roam-directory "/data/notes/orgRoam"
             org-fc-directories '("/data/notes/orgRoam"))