diff --git a/manual.html b/manual.html index d983373..99a09c2 100644 --- a/manual.html +++ b/manual.html @@ -981,11 +981,11 @@ the user. The author’s recommended configuration is as follows:

(add-to-list 'display-buffer-alist
-             '(("\\*org-roam\\*"
-                (display-buffer-in-direction)
-                (direction . right)
-                (window-width . 0.33)
-                (window-height . fit-window-to-buffer))))
+             '("\\*org-roam\\*"
+               (display-buffer-in-direction)
+               (direction . right)
+               (window-width . 0.33)
+               (window-height . fit-window-to-buffer)))
 

Crucially, the window is a regular window (not a side-window), and this allows @@ -998,6 +998,20 @@ Org-roam buffer.

  • C-u RET navigates to thing-at-point in the other window.
  • +

    For users that prefer using a side-window for the org-roam buffer, the following +example configuration should provide a good starting point: +

    +
    +
      (add-to-list 'display-buffer-alist
    +               '("\\*org-roam\\*"
    +                 (display-buffer-in-side-window)
    +                 (side . right)
    +                 (slot . 0)
    +                 (window-width . 0.33)
    +                 (window-parameters . ((no-other-window . t)
    +                                       (no-delete-other-windows . t)))))
    +
    +

    diff --git a/org-roam.org b/org-roam.org index 90e1994..994758c 100644 --- a/org-roam.org +++ b/org-roam.org @@ -519,11 +519,11 @@ the user. The author's recommended configuration is as follows: #+begin_src emacs-lisp (add-to-list 'display-buffer-alist - '(("\\*org-roam\\*" - (display-buffer-in-direction) - (direction . right) - (window-width . 0.33) - (window-height . fit-window-to-buffer)))) + '("\\*org-roam\\*" + (display-buffer-in-direction) + (direction . right) + (window-width . 0.33) + (window-height . fit-window-to-buffer))) #+end_src Crucially, the window is a regular window (not a side-window), and this allows @@ -533,6 +533,20 @@ for predictable navigation: Org-roam buffer. - ~C-u RET~ navigates to thing-at-point in the other window. +For users that prefer using a side-window for the org-roam buffer, the following +example configuration should provide a good starting point: + +#+begin_src emacs-lisp + (add-to-list 'display-buffer-alist + '("\\*org-roam\\*" + (display-buffer-in-side-window) + (side . right) + (slot . 0) + (window-width . 0.33) + (window-parameters . ((no-other-window . t) + (no-delete-other-windows . t))))) +#+end_src + ** TODO Styling the Org-roam buffer * Node Properties ** Standard Org properties diff --git a/org-roam.texi b/org-roam.texi index 29860f2..5dca0e7 100644 --- a/org-roam.texi +++ b/org-roam.texi @@ -818,11 +818,11 @@ the user. The author's recommended configuration is as follows: @lisp (add-to-list 'display-buffer-alist - '(("\\*org-roam\\*" - (display-buffer-in-direction) - (direction . right) - (window-width . 0.33) - (window-height . fit-window-to-buffer)))) + '("\\*org-roam\\*" + (display-buffer-in-direction) + (direction . right) + (window-width . 0.33) + (window-height . fit-window-to-buffer))) @end lisp Crucially, the window is a regular window (not a side-window), and this allows @@ -837,6 +837,20 @@ Org-roam buffer. @code{C-u RET} navigates to thing-at-point in the other window. @end itemize +For users that prefer using a side-window for the org-roam buffer, the following +example configuration should provide a good starting point: + +@lisp + (add-to-list 'display-buffer-alist + '("\\*org-roam\\*" + (display-buffer-in-side-window) + (side . right) + (slot . 0) + (window-width . 0.33) + (window-parameters . ((no-other-window . t) + (no-delete-other-windows . t))))) +@end lisp + @node Styling the Org-roam buffer @section @strong{TODO} Styling the Org-roam buffer