awesome-emacs/org-roam
1
0
Fork 0
mirror of https://github.com/org-roam/org-roam synced 2025-09-20 16:10:56 -05:00
Code Issues Packages Projects Releases Wiki Activity

(docs): adjusted configuration examples for backlinks buffer (#1610)

Browse Source 
- Fixed the original example's extra parenthesis, which broke the alist.
 - Added a second example for configuring the buffer as a side window.
This commit is contained in:
Carwin Young
2021-07-18 12:31:34 -05:00
committed by GitHub
parent 63450e9eaf
commit e997c017de
2 changed files with 38 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
doc/org-roam.org
View File

@@ -519,11 +519,11 @@ the user. The author's recommended configuration is as follows:
#+begin_src emacs-lisp #+begin_src emacs-lisp
(add-to-list 'display-buffer-alist (add-to-list 'display-buffer-alist
'(("\\*org-roam\\*" '("\\*org-roam\\*"
(display-buffer-in-direction) (display-buffer-in-direction)
(direction . right) (direction . right)
(window-width . 0.33) (window-width . 0.33)
(window-height . fit-window-to-buffer)))) (window-height . fit-window-to-buffer)))
#+end_src #+end_src
Crucially, the window is a regular window (not a side-window), and this allows Crucially, the window is a regular window (not a side-window), and this allows
@@ -533,6 +533,20 @@ for predictable navigation:
Org-roam buffer. Org-roam buffer.
- ~C-u RET~ navigates to thing-at-point in the other window. - ~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 ** TODO Styling the Org-roam buffer
* Node Properties * Node Properties
** Standard Org properties ** Standard Org properties

24
doc/org-roam.texi
View File

@@ -818,11 +818,11 @@ the user. The author's recommended configuration is as follows:
@lisp @lisp
(add-to-list 'display-buffer-alist (add-to-list 'display-buffer-alist
'(("\\*org-roam\\*" '("\\*org-roam\\*"
(display-buffer-in-direction) (display-buffer-in-direction)
(direction . right) (direction . right)
(window-width . 0.33) (window-width . 0.33)
(window-height . fit-window-to-buffer)))) (window-height . fit-window-to-buffer)))
@end lisp @end lisp
Crucially, the window is a regular window (not a side-window), and this allows 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. @code{C-u RET} navigates to thing-at-point in the other window.
@end itemize @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 @node Styling the Org-roam buffer
@section @strong{TODO} Styling the Org-roam buffer @section @strong{TODO} Styling the Org-roam buffer