From 7a58dcca6a8e82a8ec1ac94cf988c5ab9b164445 Mon Sep 17 00:00:00 2001 From: "Thomas F. K. Jorna" Date: Sat, 31 Jul 2021 19:04:30 +0200 Subject: add snazzyness --- README.md | 47 +++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 41 insertions(+), 6 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 6ec702b..2083b87 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # org-roam-ui: An org-roam frontend -(cool picture) +![image](https://user-images.githubusercontent.com/21983833/127746882-4ba00691-3be4-49d6-8c8c-e139a14596c2.png) + Org-Roam-UI is a frontend for exploring and interacting with your [org-roam](https://github.com/org-roam/org-roam) notes. @@ -12,30 +13,64 @@ Org-Roam-UI's main feature is the ability to generate a graph visualization of y ### Cool graph +![image](https://user-images.githubusercontent.com/21983833/127747037-aac46e8a-8617-4436-8887-ea1ad7a3141a.png) + + #### Sliders! Configure the graph just the way you like it. +![image](https://user-images.githubusercontent.com/21983833/127746907-f6283400-c7b9-432f-bd85-e37b16a753e9.png) + + #### Colors -A ton, or just a splash. +A ton +![image](https://user-images.githubusercontent.com/21983833/127747009-a4be5e47-1df6-4311-a747-71613168d028.png) + +or just a splash. +![image](https://user-images.githubusercontent.com/21983833/127746962-97ed15d2-ffeb-4a3b-9743-ad77e7efce2e.png) + #### 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! -#### 3 D -Literally deepen your understanding of your thoughts (and it looks cool) +https://user-images.githubusercontent.com/21983833/127747170-3b49fbde-7fc5-410f-bd26-4ffea8dae48c.mp4 -#### Follow your movement in Emacs, and back! + +#### 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 org-roam-ui-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 + + ## Installation `org-roam-ui` is not (yet!) on MELPA. @@ -260,7 +295,7 @@ In no particular order - Local graph show Nth neighbor - More colors - Colorization options (by neighbors, centrality, etc) -- +- Setting profiles ### UI in general -- cgit v1.2.3 From a20805fe8ddb17395e131959a672d33a6420a24e Mon Sep 17 00:00:00 2001 From: "Thomas F. K. Jorna" Date: Sat, 31 Jul 2021 19:07:10 +0200 Subject: moved features because big --- README.md | 133 +++++++++++++++++++++++++++++++++----------------------------- 1 file changed, 70 insertions(+), 63 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 2083b87..b6fd09d 100644 --- a/README.md +++ b/README.md @@ -7,69 +7,6 @@ Org-Roam-UI is a frontend for exploring and interacting with your [org-roam](htt Org-Roam-UI is meant a successor of 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. -## Features ✨ - -Org-Roam-UI's main feature is the ability to generate a graph visualization of your org-roam notes. - -### Cool graph - -![image](https://user-images.githubusercontent.com/21983833/127747037-aac46e8a-8617-4436-8887-ea1ad7a3141a.png) - - -#### Sliders! - -Configure the graph just the way you like it. - -![image](https://user-images.githubusercontent.com/21983833/127746907-f6283400-c7b9-432f-bd85-e37b16a753e9.png) - - -#### Colors - -A ton -![image](https://user-images.githubusercontent.com/21983833/127747009-a4be5e47-1df6-4311-a747-71613168d028.png) - -or just a splash. -![image](https://user-images.githubusercontent.com/21983833/127746962-97ed15d2-ffeb-4a3b-9743-ad77e7efce2e.png) - - -#### 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! - - -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 org-roam-ui-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 - ## Installation @@ -284,6 +221,76 @@ Hopefully, yeah! But time is limited, and so is the amount of features we can cr Correct! We only support org-roam v2! +## Features ✨ + +Org-Roam-UI's main feature is the ability to generate a graph visualization of your org-roam notes. + +### Cool graph + +![image](https://user-images.githubusercontent.com/21983833/127747037-aac46e8a-8617-4436-8887-ea1ad7a3141a.png) + + +#### Sliders! + +Configure the graph just the way you like it. + +![image](https://user-images.githubusercontent.com/21983833/127746907-f6283400-c7b9-432f-bd85-e37b16a753e9.png) + + +#### Colors + +A ton + + +![image](https://user-images.githubusercontent.com/21983833/127747009-a4be5e47-1df6-4311-a747-71613168d028.png) + +or just a splash. + + +![image](https://user-images.githubusercontent.com/21983833/127746962-97ed15d2-ffeb-4a3b-9743-ad77e7efce2e.png) + + +#### 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! + + +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 org-roam-ui-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 -- cgit v1.2.3 From b46b1abb2feb10821d8d722f82d938c6b644c3a2 Mon Sep 17 00:00:00 2001 From: "Thomas F. K. Jorna" Date: Sat, 31 Jul 2021 19:07:53 +0200 Subject: removed org-protocol references --- README.md | 9 --------- 1 file changed, 9 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index b6fd09d..6cb16b5 100644 --- a/README.md +++ b/README.md @@ -15,15 +15,6 @@ Org-Roam-UI is meant a successor of https://github.com/org-roam/org-roam-server 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. -### Prerequisites - -The graph utilizes `org-protocol`, which means if you click on one -of the nodes, it will open the corresponding file in Emacs. For this -feature to work, org-roam protocol should be configured in the system. - -[Configuring Org-Roam Protocol](https://www.orgroam.com/manual.html#Installation-_00281_0029) - -Also make sure the emacs server is started; `M-x server-start RET` ### Manually -- cgit v1.2.3 From 5a66bc6c1adf0812a290bf4f5fee186793d1122f Mon Sep 17 00:00:00 2001 From: "Thomas F. K. Jorna" Date: Sat, 31 Jul 2021 19:08:43 +0200 Subject: corrected installation instructions --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 6cb16b5..d110ab7 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ Add the following to your `package.el` ```emacs-lisp (package! websocket) -(package! org-roam-ui :recipe (:host github :repo org-roam/org-roam-ui :files "*.el out") +(package! org-roam-ui :recipe (:host github :repo org-roam/org-roam-ui :files ("*.el" "out"))) ``` Then something along the following to your `config.el` -- cgit v1.2.3 From cb5a9c62900a09ee37f3d53452f71cbe12eccd52 Mon Sep 17 00:00:00 2001 From: "Thomas F. K. Jorna" Date: Sat, 31 Jul 2021 19:12:42 +0200 Subject: development guidelines --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index d110ab7..b613c3d 100644 --- a/README.md +++ b/README.md @@ -307,6 +307,12 @@ In no particular order # Contribute 💪 +```bash +git clone https://github.com/org-roam/org-roam-ui +yarn +yarn dev +``` + [GitHub Community Guidelines ](https://docs.github.com/en/github/site-policy/github-community-guidelines) apply. -- cgit v1.2.3 From 51e4752937a790132e9a45fd05bd5b7bf75e9d10 Mon Sep 17 00:00:00 2001 From: "Thomas F. K. Jorna" Date: Sat, 31 Jul 2021 20:28:44 +0200 Subject: Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index b613c3d..636af9c 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ -# org-roam-ui: An org-roam frontend +# org-roam-ui: an org-roam frontend ![image](https://user-images.githubusercontent.com/21983833/127746882-4ba00691-3be4-49d6-8c8c-e139a14596c2.png) 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 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. +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 -- cgit v1.2.3 From 7d3ebb6b5b49596300e514e0a73550facff2fee2 Mon Sep 17 00:00:00 2001 From: "Thomas F. K. Jorna" Date: Sat, 31 Jul 2021 20:47:07 +0200 Subject: fixed recipe name --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 636af9c..bc07158 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ Add the following to your `package.el` ```emacs-lisp (package! websocket) -(package! org-roam-ui :recipe (:host github :repo org-roam/org-roam-ui :files ("*.el" "out"))) +(package! org-roam-ui :recipe (:host github :repo "org-roam/org-roam-ui" :files ("*.el" "out"))) ``` Then something along the following to your `config.el` -- cgit v1.2.3 From 0e864d93dc8b581e7c7d7a8a01221ec634d3a6fb Mon Sep 17 00:00:00 2001 From: shaunsingh Date: Sat, 31 Jul 2021 15:08:24 -0400 Subject: Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index bc07158..76946a4 100644 --- a/README.md +++ b/README.md @@ -206,7 +206,7 @@ At the moment we aren't showing citation links made with `org-roam-bibtex` yet, ### Q: Will you implement X? -Hopefully, yeah! But time is limited, and so is the amount of features we can cram into this things before it implodes in itself, so we are adding things incrementally to make sure they work. That said, we'd love to hear from you! Please post feature requests in [this discussion]() or upvote those already posted, this way we can adjust our priorities somewhat! +Hopefully, yeah! But time is limited, and so is the amount of features we can cram into this things before it implodes in itself, so we are adding things incrementally to make sure they work. That said, we'd love to hear from you! Please post feature requests in [this discussion](https://github.com/org-roam/org-roam-ui/discussions/6) or upvote those already posted, this way we can adjust our priorities somewhat! ### Q: This doesn't work with org-roam v1/org-brain/Zettledelft! @@ -303,7 +303,7 @@ In no particular order ### Beyond -- Discuss the future of org-roam-ui with us (here!)[https://github.com/org-roam/org-roam-ui/discussions/6] +- Discuss the future of org-roam-ui with us [here!](https://github.com/org-roam/org-roam-ui/discussions/6) # Contribute 💪 -- cgit v1.2.3 From 9bef309b47dae09275634355ca308d62fc3cffb1 Mon Sep 17 00:00:00 2001 From: "Thomas F. K. Jorna" Date: Sat, 31 Jul 2021 21:32:14 +0200 Subject: straight usepackage instructions --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 76946a4..5c71279 100644 --- a/README.md +++ b/README.md @@ -64,14 +64,20 @@ 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. -### Quelpa/use-package - +### 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 + :hook (org-roam . org-roam-ui-mode)) +``` TODO You probably know how to do this ## Usage -Use `M-x org-roam-ui RET` to enable the global mode. +Use `M-x org-roam-ui-mode RET` to enable the global mode. It will start a web server on http://127.0.0.1:35901/ and connect to it via a WebSocket for real-time updates. ### Commands -- cgit v1.2.3 From 5eac0fbdd8a587682f91ad7ed49bf80cf8e9ff78 Mon Sep 17 00:00:00 2001 From: "Thomas F. K. Jorna" Date: Sat, 31 Jul 2021 21:36:25 +0200 Subject: Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 5c71279..aad4ea7 100644 --- a/README.md +++ b/README.md @@ -267,7 +267,7 @@ https://user-images.githubusercontent.com/21983833/127747187-7823a825-a2f8-449c- #### Theme syncing -Your gruvbox is only a `M-x org-roam-ui-sync-theme` away. +Your gruvbox is only a `M-x orui-sync-theme` away. https://user-images.githubusercontent.com/21983833/127747203-a1aeca95-7def-4caf-b2cf-8a18fa1f2059.mp4 -- cgit v1.2.3