Browse Source

Add roam documentation

main
parent
commit
c3295228d3
  1. 35
      README.org

35
README.org

@ -512,18 +512,13 @@ Some methods must be called and applied to the current call process in order to
(apply #'call-process `(,(car command-parts) nil 0 nil ,@(cdr command-parts))))) (apply #'call-process `(,(car command-parts) nil 0 nil ,@(cdr command-parts)))))
#+end_src #+end_src
Place keybindings for executing shell commands behind =SPC x=.
+ Run with =x=
+ Run in backround with =g=
+ Run asynchronously with =z=
+ Run shell commands with =SPC x=
+ Run async shell commands with =SPC z=
#+begin_src emacs-lisp #+begin_src emacs-lisp
(dotfiles/leader (dotfiles/leader
"x" '(:ignore t :which-key "Execute")
"xx" '(dotfiles/run :which-key "Run")
"xb" '(dotfiles/run-in-background :which-key "Run (background)")
"xz" '(async-shell-command :which-key "Async"))
"x" '(dotfiles/run :which-key "Run")
"z" '(async-shell-command :which-key "Async"))
#+end_src #+end_src
*** Initialization *** Initialization
@ -623,17 +618,31 @@ Produce high quality presentations that work anywhere with =HTML/JS= and the [[h
*** Roam *** Roam
Download and install [[https://orgroam.com][org-roam]], a plain text knowledge management system for Emacs.
#+begin_src emacs-lisp #+begin_src emacs-lisp
(use-package org-roam (use-package org-roam
:hook (after-init . org-roam-mode) :hook (after-init . org-roam-mode)
:custom (org-roam-directory org-directory)) :custom (org-roam-directory org-directory))
#+end_src #+end_src
Visualize the org-roam database with the server, available when the editor is running at http://localhost:8080
#+begin_src emacs-lisp #+begin_src emacs-lisp
(use-package org-roam-server (use-package org-roam-server
:hook (org-roam-mode . org-roam-server-mode)) :hook (org-roam-mode . org-roam-server-mode))
#+end_src #+end_src
Place keybindings behind =SPC r=.
+ Find with =f=
+ Toggle buffer with =b=
+ Dailies with =d=
+ Arbitrary date with =d=
+ Today with =t=
+ Tomorrow with =m=
+ Yesterday with =y=
#+begin_src emacs-lisp #+begin_src emacs-lisp
(dotfiles/leader (dotfiles/leader
"r" '(:ignore t :which-key "Roam") "r" '(:ignore t :which-key "Roam")
@ -646,6 +655,12 @@ Produce high quality presentations that work anywhere with =HTML/JS= and the [[h
"rdy" '(org-roam-dailies-find-yesterday :which-key "Yesterday")) "rdy" '(org-roam-dailies-find-yesterday :which-key "Yesterday"))
#+end_src #+end_src
Organize the capture templates, this allows me to quickly dictate where each new item should be placed.
+ ~posts/~ contains blog posts
+ ~notes/~ contains cited notes on others' work
+ ~slides/~ contains presentations / screencasts
#+begin_src emacs-lisp #+begin_src emacs-lisp
(setq org-roam-capture-templates (setq org-roam-capture-templates
'(("p" "Posts" plain (function org-roam-capture--get-point) '(("p" "Posts" plain (function org-roam-capture--get-point)
@ -692,6 +707,8 @@ Produce high quality presentations that work anywhere with =HTML/JS= and the [[h
"))) ")))
#+end_src #+end_src
By default I want my daily notes to live in ~daily/~ relative to my dotfiles.
#+begin_src emacs-lisp #+begin_src emacs-lisp
(setq org-roam-dailies-capture-templates (setq org-roam-dailies-capture-templates
'(("d" "Default" entry (function org-roam-capture--get-point) '(("d" "Default" entry (function org-roam-capture--get-point)

Loading…
Cancel
Save