Skip to content

Configuring what is displayed in the buffer

There are currently 3 provided widget types:

View (preview of) nodes that link to this node

Nodes that reference this node (see Refs)

Unlinked references

View nodes that contain text that match the nodes title/alias but are not linked

To configure what sections are displayed in the buffer, set org-roam-mode-sections.

emacs-lisp
(setq org-roam-mode-sections
      (list #'org-roam-backlinks-section
            #'org-roam-reflinks-section
            ;; #'org-roam-unlinked-references-section
            ))

Note that computing unlinked references may be slow, and has not been added in by default.

For each section function, you can pass args along to modify its behaviour. For example, if you want to render unique sources for backlinks (and also keep rendering reference links), set org-roam-mode-sections as follows:

emacs-lisp
(setq org-roam-mode-sections
      '((org-roam-backlinks-section :unique t)
        org-roam-reflinks-section))

The backlinks section org-roam-backlinks-section also supports a predicate to filter backlinks, :show-backlink-p. This can be used as follows:

emacs-lisp
(defun my-org-roam-show-backlink-p (backlink)
  (not (member "daily" (org-roam-node-tags (org-roam-backlink-source-node backlink)))))

(setq org-roam-mode-sections
      '((org-roam-backlinks-section :unique t :show-backlink-p my-org-roam-show-backlink-p)
        org-roam-reflinks-section))