org-roam-treeview's Introduction

org-roam-treeview

This is a simple tree presentation for Org-roam.

Installation

(require 'org-roam-treeview)

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

(setq org-roam-treeview-startids '("1cfc93fd-d5d1-4031-9c71-785216bb9f32"))

Or use straight (or use-package):

(use-package org-roam-treeview
    :straight (org-roam-treeview :type git :host github :repo "/odomanov/org-roam-treeview")
    :after (org org-roam)
    :config
    (setq org-roam-treeview-startids '("1cfc93fd-d5d1-4031-9c71-785216bb9f32"
                                       "9a9d1aae-ab3d-417b-a4af-36b8eadeed7e"
                                       "d38820a6-e63c-47b3-9191-a5813f57bb8a"))
    :bind
    (("C-=" . #'org-roam-treeview)
     :map org-roam-treeview-map
     ("й" . #'org-roam-treeview-hide-buffer)
     ("Й" . #'org-roam-treeview-kill-buffer)
     ("C-=" . #'org-roam-treeview)
     ))

After that launch org-roam-treeview (or press C-= with the configuration above). This opens a window on the right side which shows the tree view of the Org-roam network.

Commands

TAB: Expand/contract the current node.
RET: Open the file corresponding to the current node.
<, >: Enlarge/Shrink the window.
q: Bury the Org-roam Treemacs buffer
Q: Kill the Org-roam Treemacs buffer

You may use the mouse as well.

Customization

org-roam-treeview-startids: The list of node IDs for the initial display. The default is nil, so you need to set up the list to see anything in the beginning.
org-roam-treeview-map: The keymap used. It can be configured after the package loading.
org-roam-treeview-width: The initial width of the Org-roam treeview window.
org-roam-treeview-indent: The indentation of treeview levels. The default is 2.
org-roam-treeview-hook: is the hook to run after the package loading.

Recommend Projects