/org-roam-speedbar

Primary LanguageEmacs LispGNU General Public License v3.0GPL-3.0

org-roam-speedbar

This is a simple Org-roam display mode for Emacs Speedbar.

Installation

(require 'org-roam-speedbar)

Before you use org-roam-speedbar you need to customize or set up the list of starting nodes. For example:

(setq org-roam-sb-startids '("1cfc93fd-d5d1-4031-9c71-785216bb9f32"
                             "d38820a6-e63c-47b3-9191-a5813f57bb8a"))

Or use straight (or use-package):

(use-package org-roam-speedbar
    :straight (org-roam-speedbar :type git :host github
                                 :repo "/odomanov/org-roam-speedbar")
    :after speedbar
    :config
    (setq org-roam-sb-startids '("1cfc93fd-d5d1-4031-9c71-785216bb9f32"
                                 "d38820a6-e63c-47b3-9191-a5813f57bb8a"))
    (setq speedbar-frame-parameters '((minibuffer)
                                      (width . 50)
                                      (border-width . 0)
                                      (menu-bar-lines . 0)
                                      (tool-bar-lines . 0)
                                      (unsplittable . t)
                                      (left-fringe . 0))))

After that launch speedbar. In Files and Buffers display modes the command o switches to the Org-roam display mode. It shows the list of org-roam-sb-startids.

Commands

Usual Speedbar commands for the cursor movement apply.

Other commands:

o
Start from the very beginning.
TAB
+
=
Expand/contract the current node.
RET
Open the file corresponding to the current node.
f
b
Switch to the Files or Buffers display mode accordingly.