|Nicolas Petton 425e78770d||2 years ago|
|.github||2 years ago|
|screenshots||2 years ago|
|LICENSE||2 years ago|
|nroam-backlinks.el||2 years ago|
|nroam-unlinked.el||2 years ago|
|nroam-utils.el||2 years ago|
|nroam.el||2 years ago|
|readme.org||2 years ago|
nroam is a supplementary package for org-roam that replaces the
backlink side buffer of Org-roam. Instead, it displays org-roam
backlinks at the end of org-roam buffers. The user can also click a
button to see unlinked occurrences of the buffer title (as defined by
One of the ideas behind nroam is to remove the friction and effort it takes to consult backlinks. I consider backlinks to be a very central piece of information about a note. Backlinks can even be the most important content of a note, for instance when using page links as tags.
It is easy to miss backlinks when they are not always visible with the main content of a note. The side buffer will not always be open, and even if it is, the information it contains is visually far away from the note you're looking at.
By making them an integral part of the org buffer, backlinks also
become more powerful. You could for instance make a sparse tree—see
org-sparse-tree — to filter the contents of a note and its backlinks
at the same time.
nroam is not yet available in MELPA. Until it is, you can install the Elisp files by hand in your
.emacs.d or if you use
straight.el add the following to you init file.
(use-package nroam :straight '(nroam :host github :branch "master" :repo "NicolasPetton/nroam") :after org-roam :config (add-hook 'org-mode-hook #'nroam-setup-maybe))
To setup nroam for all
org-mode buffer, evaluate the following:
(add-hook 'org-mode-hook #'nroam-setup-maybe)
The linked references section will be updated after each buffer save.
It can also be manually updated by typing
C-c C-c anywhere in the
linked references section.
This package is in its infancy. Be careful when using it as it
org-mode buffers—it should not modify your files
though. Backup your data often.