diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 32 |
1 files changed, 7 insertions, 25 deletions
@@ -2,12 +2,10 @@  - Org-Roam-UI is a frontend for exploring and interacting with your [org-roam](https://github.com/org-roam/org-roam) notes. Org-Roam-UI is meant a successor of [org-roam-server](https://github.com/org-roam/org-roam-server) that extends functionality of org-roam with a Web app that runs side-by-side with Emacs. - ## Installation `org-roam-ui` is not (yet!) on MELPA. @@ -15,7 +13,6 @@ Org-Roam-UI is meant a successor of [org-roam-server](https://github.com/org-roa Should your Emacs miss any of the dependencies, please install them manually! org-roam-ui requires `org-roam`, `websocket`, `simple-httpd`, `f` and Emacs >27 for fast JSON parsing. - ### Manually Install `websocket.el` @@ -65,13 +62,15 @@ Then something along the following to your `config.el` We recommend only loading org-roam-ui after loading org(-roam) as starting the server and making database requests can impact startup times quite a lot. ### straight/use-package + ```emacs-lisp -(use-package org-roam-ui - :straight - (:host github :repo "org-roam/org-roam-ui" :branch "main" :files ("*.el" "out")) - :after org-roam +(use-package org-roam-ui + :straight + (:host github :repo "org-roam/org-roam-ui" :branch "main" :files ("*.el" "out")) + :after org-roam :hook (org-roam . org-roam-ui-mode)) ``` + TODO You probably know how to do this @@ -226,68 +225,51 @@ Org-Roam-UI's main feature is the ability to generate a graph visualization of y  - #### Sliders! Configure the graph just the way you like it.  - #### Colors A ton -  or just a splash. -  - #### Open notes in Emacs (Double) clicking a node will open the corresponding note in Emacs, very cool. -You *don't* need org-protocol for this, it works out of the box! - +You _don't_ need org-protocol for this, it works out of the box! https://user-images.githubusercontent.com/21983833/127747170-3b49fbde-7fc5-410f-bd26-4ffea8dae48c.mp4 - #### Follow your movement in Emacs! When you open a note in Emacs, org-roam-ui will move to the corresponding node on the graph. - https://user-images.githubusercontent.com/21983833/127747187-7823a825-a2f8-449c-a0ec-1c5c525621dc.mp4 - - #### Theme syncing Your gruvbox is only a `M-x orui-sync-theme` away. - https://user-images.githubusercontent.com/21983833/127747203-a1aeca95-7def-4caf-b2cf-8a18fa1f2059.mp4 #### Filters - - https://user-images.githubusercontent.com/21983833/127747222-7c768e37-4948-4072-895b-a55ff7b5906a.mp4 - - #### 3 D Literally deepen your understanding of your thoughts (and it looks cool) https://user-images.githubusercontent.com/21983833/127747234-d0588cdf-623f-4d13-a060-737bc570b295.mp4 - - ## Planned features ### Graph |