Function: org-roam-mode

org-roam-mode is an interactive and byte-compiled function defined in org-roam-mode.el.

Signature

(org-roam-mode)

Documentation

Major mode for displaying relevant information about Org-roam nodes.

This mode is used by special Org-roam buffers, such as persistent org-roam-buffer(var)/org-roam-buffer(fun) and dedicated Org-roam buffers
(org-roam-buffer-display-dedicated), which render the
information in a section-like manner (see org-roam-mode-sections), with which the user can interact with.

In addition to any hooks its parent mode magit-section-mode might have run, this mode runs the hook org-roam-mode-hook, as the final or penultimate step during initialization.

                         org-roam-buffer-refresh
- negative-argument
0 digit-argument
1 magit-section-show-level-1
2 magit-section-show-level-2
3 magit-section-show-level-3
4 magit-section-show-level-4
<backtab> magit-section-cycle-global
<left-fringe> <mouse-1> magit-mouse-toggle-section
<left-fringe> <mouse-2> magit-mouse-toggle-section
C-<return> org-roam-buffer-visit-thing
C-<tab> magit-section-cycle
C-c TAB magit-section-cycle
M-1 magit-section-show-level-1-all
M-2 magit-section-show-level-2-all
M-3 magit-section-show-level-3-all
M-4 magit-section-show-level-4-all
M-<tab> magit-section-cycle
M-n magit-section-forward-sibling
M-p magit-section-backward-sibling
RET org-roam-buffer-visit-thing
SPC..~ undefined
TAB magit-section-toggle
^ magit-section-up
n magit-section-forward
p magit-section-backward
q..\x3FFFFF digit-argument

Key Bindings

Source Code

;; Defined in ~/.emacs.d/elpa/org-roam-20260224.1637/org-roam-mode.el
(define-derived-mode org-roam-mode magit-section-mode "Org-roam"
  "Major mode for displaying relevant information about Org-roam nodes.
This mode is used by special Org-roam buffers, such as persistent
`org-roam-buffer' and dedicated Org-roam buffers
\(`org-roam-buffer-display-dedicated'), which render the
information in a section-like manner (see
`org-roam-mode-sections'), with which the user can
interact with."
  :group 'org-roam
  (face-remap-add-relative 'header-line 'org-roam-header-line)
  ;; https://github.com/meedstrom/org-node/issues/149
  (setq-local font-lock-defaults nil))