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.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
Nicolas Petton b7e79c5ed8
Fix a let(*) definition
7 hours ago
.github Create FUNDING.yml 2 days ago
screenshots * readme.org: Update for unlinked references 3 days ago
LICENSE Initial commit 1 week ago
nroam-backlinks.el Fix a let(*) definition 7 hours ago
nroam-unlinked.el Add support for unlinked references 3 days ago
nroam-utils.el Split nroam.el 3 days ago
nroam.el Add support for unlinked references 3 days ago
readme.org * readme.org: Copyedit. 3 days ago

readme.org

nroam

nroam is a supplementary package for org-roam that replaces the backlink side buffer of Org-roam. Instead, it displays org-roam backlinks—as well as unlinked references—at the end of org-roam buffers.

Screenshots

Backlinks

file:screenshots/backlinks.png

Unlinked references

file:screenshots/unlinked-references.png

Rationale

One of the ideas behing 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.

Setup & usage

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.

Warning

This package is in its infancy. Be careful when using it as it modifies your org-mode buffers—it should not modify your files though. Backup your data often.