awesome-emacs/org-roam
1
0
Fork 0
mirror of https://github.com/org-roam/org-roam synced 2025-08-13 13:13:31 -05:00
Code Issues Packages Projects Releases Wiki Activity

Updated Hitchhiker's "Rough" Guide to Org roam V2 (org)

Jethro Kuan
2021-03-27 16:41:11 +08:00
parent f932ba86bf
commit 2298feea83
1 changed files with 18 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
Hitchhiker's-"Rough"-Guide-to-Org-roam-V2.org

@@ -20,17 +20,17 @@ If this does not make sense to you and have no idea how you might go about insta
You can clone the repo, or download its content, and proceed to configuration in the next sections.
For Doom, adding the following to =package.el= and do =doom -sync= should get you V2.
For Doom, adding the following to =~=/.doom.d/packages.el= and do =doom sync -u= should get you V2.
#+begin_src emacs-lisp
(package! org-roam
:recipe (:host github :repo "org-roam/org-roam" :branch "v2"))
#+end_src
*** Configuration for Vanilla Emacs (No Distribution such as Doom or Spacemancs)
*** Configuration for Vanilla Emacs (No Distribution such as Doom or Spacemacs)
It is advised that all the V1 config be commented out.
For example, nobiot uses the following set up to manually activate V2. It's not exactly how he does it, as he uses his own enhancement (e.g. =md-roam= to enable Org-roam to recognise Markdown files -- its minimum set of functions works for V2 and available in his repo).
For example, @nobiot uses the following set up to manually activate V2. It's not exactly how he does it, as he uses his own enhancement (e.g. =md-roam= to enable Org-roam to recognise Markdown files -- its minimum set of functions works for V2 and available in his repo).
#+begin_src emacs-lisp
(defun my/org-roam-load ()
(interactive)
@@ -117,7 +117,7 @@ Configuration of the display of the buffer (whether it should be a side-window,
#+begin_src emacs-lisp
;; for org-roam-buffer-toggle
(setq display-buffer-alist
(add-to-list 'display-buffer-alist
'(;; Left side window
(".org-roam.*"
(display-buffer-in-side-window)
@@ -126,6 +126,17 @@ Configuration of the display of the buffer (whether it should be a side-window,
(slot . 0))))
#+end_src
or
#+begin_src emacs-lisp
;; for org-roam-buffer-toggle
(add-to-list 'display-buffer-alist
'(("\\*org-roam\\*"
(display-buffer-in-direction)
(direction . right)
(window-width . 0.33)
(window-height . fit-window-to-buffer))))
#+end_src
*** Tags
V2 only uses tags of Org Mode. The unique tag system used by V1 is no longer recognized by V2.
@@ -134,6 +145,9 @@ V2 only uses tags of Org Mode. The unique tag system used by V1 is no longer rec
*** TODO Migrating Notes from V1 to V2 (WIP)
There's an incomplete migration script here:
https://gist.github.com/jethrokuan/02f41028fb4a6f81787dc420fb99b6e4/
*** TODO Hiding Properties
This snippet can be turned into a toggle. If you have done it, please share how.