diff options
| author | Thomas F. K. Jorna <[email protected]> | 2021-08-02 11:16:54 +0200 |
|---|---|---|
| committer | GitHub <[email protected]> | 2021-08-02 11:16:54 +0200 |
| commit | d6caa6a7fa000d80f7d41f5d8f3f05d47abde74c (patch) | |
| tree | 98e20da7763039677bc64513273748760b8c3145 /README.md | |
| parent | 197a3c7060945d422ccb1c3504bfda93791ea380 (diff) | |
fix: changed readme info about hooks
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 35 |
1 files changed, 28 insertions, 7 deletions
@@ -53,9 +53,16 @@ Then something along the following to your `config.el` (use-package! org-roam-ui :after org-roam ;; or :after org - :hook (org-roam . org-roam-ui-mode) + :hook +;; normally we'd recommend hooking orui after org-roam, but since org-roam does not have +;; a hookable mode anymore, you're advised to pick something yourself +;; if you don't care about startup time, use +;; :hook (after-init . org-roam-ui-mode) :config -) + (setq org-roam-ui-sync-theme t + org-roam-ui-follow t + org-roam-ui-update-on-save t + org-roam-ui-open-on-start t)) ``` @@ -68,11 +75,19 @@ We recommend only loading org-roam-ui after loading org(-roam) as starting the s :straight (:host github :repo "org-roam/org-roam-ui" :branch "main" :files ("*.el" "out")) :after org-roam - :hook (org-roam . org-roam-ui-mode)) + :hook +;; normally we'd recommend hooking orui after org-roam, but since org-roam does not have +;; a hookable mode anymore, you're advised to pick something yourself +;; if you don't care about startup time, use +;; :hook (after-init . org-roam-ui-mode) + :config + (setq org-roam-ui-sync-theme t + org-roam-ui-follow t + org-roam-ui-update-on-save t + org-roam-ui-open-on-start t)) + ``` -TODO -You probably know how to do this ## Usage @@ -142,8 +157,7 @@ You can also provide your own theme if you do not like syncing nor like the defa ```emacs-lisp (setq org-roam-ui-custom-theme - (list - (bg . "#1E2029") + '((bg . "#1E2029") (bg-alt . "#282a36") (fg . "#f8f8f2") (fg-alt . "#6272a4") @@ -159,6 +173,13 @@ You can also provide your own theme if you do not like syncing nor like the defa You can optionally provide `(base1 . "#XXXXXX")` arguments after the last one to also set the background shades, otherwise ORUI will guess based on the provides bg and fg. +### Open on start + +By default, org-roam-ui will try to open itself in your default browser. To disable this, set +```emacs-lisp +(setq org-roam-ui-open-on-start nil) +``` + ## Disclaimers ‼ - We only support [org-roam v2](https://blog.jethro.dev/posts/org_roam_v2/); v1 will never be supported. |