diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 71 |
1 files changed, 54 insertions, 17 deletions
@@ -1,8 +1,27 @@ -# org-roam-ui: a graphical frontend for your org-roam Zettelkasten - [](https://github.com/org-roam/org-roam-ui/actions/workflows/ci.yml) - +<img width="1440" alt="Screenshot 2021-10-12 at 12 51 39" src="https://user-images.githubusercontent.com/21983833/136942774-3f293f65-dbd4-4479-b530-1fde738c5289.png"> + +# org-roam-ui: a graphical frontend for your org-roam Zettelkasten + +**Table of Contents** + +- [Changelog](#changelog) +- [Installation](#installation) + - [Manually](#manually) + - [Doom](#doom) + - [straight/use-package](#straightuse-package) +- [Usage](#usage) +- [Disclaimers ‼](#disclaimers-) +- [FAQ 🗨](#faq-) +- [Features ✨](#features-) + - [Planned features](#planned-features) +- [Supporting org-roam-ui](#supporting-org-roam-ui) + - [Feedback](#feedback) + - [Contribute 💪](#contribute-) + - [Hacktoberfest](#hacktoberfest) + - [Donate](#donate) + - [Sponsors](#sponsors) Org-Roam-UI is a frontend for exploring and interacting with your [org-roam](https://github.com/org-roam/org-roam) notes. @@ -48,6 +67,7 @@ Add the following to your `package.el` Org-roam-ui tries to keep up with the latest features of `org-roam`, which conflicts with Doom Emacs's desire for stability. To make sure nothing breaks, use the latest version of `org-roam` by unpinning it. + ```emacs-lisp (unpin! org-roam) (package! websocket) @@ -197,7 +217,7 @@ By default, org-roam-ui will try to open itself in your default browser. To disa ## FAQ 🗨 -## Q: Aaaaand it broke: what do? +### Q: Aaaaand it broke: what do? Sorry! This is still alpha software, so expect it to break from time to time. Best thing you can try is to remove your settings by going to "Storage > Local Storage" on Firefox or "Application > Local Storage" on Chromium and deleting everything there. @@ -209,9 +229,9 @@ If the issue still persists, please file a bug report with and we'll try to help you ASAP! -## Q: Clicking 'Open in Emacs' gives an error around json-parse-string, how do I fix this? +### Q: Clicking 'Open in Emacs' gives an error around json-parse-string, how do I fix this? -If you receive an error, in emacs, stating `function definition is void json-parse-string`, then you must compile emacs with json support. This is not automatically done on systems such as Gentoo. +If you receive an error, in emacs, stating `function definition is void json-parse-string`, then you must compile emacs with json support. This is not automatically done on systems such as Gentoo. ### Q: Graph Slow! Faster? @@ -255,16 +275,16 @@ In our experience, once the graph has actually settled and nothing needs to be r ### 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! -If your feature is not already on the [project board](https://github.com/org-roam/org-roam-ui/projects/2), please post minor feature requests such as "I want to be able to color this specific node" in [the minor feature requests discussion](https://github.com/org-roam/org-roam-ui/discussions/6) and *major* feature requests (e.g. "I want to publish my graph) in [the major feature requests discussion](https://github.com/org-roam/org-roam-ui/discussions/66) 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! +If your feature is not already on the [project board](https://github.com/org-roam/org-roam-ui/projects/2), please post minor feature requests such as "I want to be able to color this specific node" in [the minor feature requests discussion](https://github.com/org-roam/org-roam-ui/discussions/6) and _major_ feature requests (e.g. "I want to publish my graph) in [the major feature requests discussion](https://github.com/org-roam/org-roam-ui/discussions/66) 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! -Correct! We only support org-roam v2! +Correct! We only support org-roam v2, although we might introduce a backend agnostic implementation later. ## Features ✨ -Org-Roam-UI's main feature is the ability to generate a graph visualization of your org-roam notes. +Org-roam-ui's main feature is the ability to generate a graph visualization of your org-roam notes. ### Cool graph @@ -283,7 +303,6 @@ For when you leave Emacs in a moment of weakness. https://user-images.githubusercontent.com/21983833/136845036-a6bd4b32-d78c-4bcf-aa8a-0e37c69cbbe8.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. @@ -298,7 +317,9 @@ https://user-images.githubusercontent.com/21983833/127747203-a1aeca95-7def-4caf- #### Filters -https://user-images.githubusercontent.com/21983833/127747222-7c768e37-4948-4072-895b-a55ff7b5906a.mp4 +Filter out all those "temporary" notes you'll sift through someday. + +https://user-images.githubusercontent.com/21983833/136944460-76b92e7c-7cf5-40d0-89f4-bdabfa41fe01.mp4 #### 3 D @@ -315,7 +336,6 @@ In no particular order - ~~Citation links + customization~~ - ~~Tag filtering/coloring~~ - Local graph show Nth neighbor -- More colors - Colorization options (by neighbors, centrality, etc) - Setting profiles @@ -325,12 +345,17 @@ In no particular order - Displaying notes Andy Matushak style - Discovery options, e.g. "show shortest path between X and Y" -# Feedback +# Supporting org-roam-ui + +## Feedback For feature suggestions, please make an issue or check out the discussions for [major](https://github.com/org-roam/org-roam-ui/discussions/66) and [minor features](https://github.com/org-roam/org-roam-ui/discussions/6). For other feedback, please go to the [feedback discussion](https://github.com/org-roam/org-roam-ui/discussions/99), or open up a new one! -# Contribute 💪 +## Contribute 💪 + +The best way to support the continued development of org-roam-ui is to get involved yourself! +To get started, simply ```bash git clone https://github.com/org-roam/org-roam-ui @@ -338,9 +363,21 @@ yarn yarn dev ``` +and a development server will be lauched on `localhost:3000`. + [GitHub Community Guidelines ](https://docs.github.com/en/github/site-policy/github-community-guidelines) apply. -Go [here](https://github.com/org-roam/org-roam-ui/discussions/4) to have an onboarding call with a member of the core team. +If you are interested in being more closely involved with the project, go [here](https://github.com/org-roam/org-roam-ui/discussions/4) to have an onboarding call with a member of the core team. + +We would ❤️ to have you on board! + +### Hacktoberfest + +Org-roam-ui is also participating in Hacktoberfest 2021! [Enter Hacktoberfest](https://hacktoberfest.digitalocean.com/), check out the [issues labeled Hacktoberfest](https://github.com/org-roam/org-roam-ui/issues) and get a free (as in beer) t-shirt! (as well as the moral satisfaction of contributing to free software, but hey, t-shirt) + +## Donate + +If you really really like org-roam-ui, you can make a [one-time donation or sponsor one of us monthly!](https://github.com/sponsors/ThomasFKJorna/) -We would ❤️ to have you on board. +### Sponsors |