nico
/
nroam
2
1
Fork 0
Code Issues 0 Pull Requests 0 Projects 0 Releases 1 Wiki Activity
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.
73 Commits
1 Branch
779 KiB
 
Tree: 425e78770d
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '425e78770d'
${ noResults }
 ZIP  TAR.GZ
Nicolas Petton 425e78770d
* nroam-utils.el (nroam--insert-heading): Copyedit docstring. 		2 years ago
.github Create FUNDING.yml 2 years ago
screenshots * readme.org: Update for unlinked references 2 years ago
LICENSE Initial commit 2 years ago
nroam-backlinks.el Fix a byte-compiler warning 2 years ago
nroam-unlinked.el Organize backlinks under single heading 2 years ago
nroam-utils.el * nroam-utils.el (nroam--insert-heading): Copyedit docstring. 2 years ago
nroam.el Organize backlinks under single heading 2 years ago
readme.org Fix #9 2 years 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 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 org-roam-unlinked-references).

Screenshots

Backlinks

file:screenshots/backlinks.png

Unlinked references

file:screenshots/unlinked-references.png

Rationale

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.

Installation

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))

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.