https://github.com/org-roam/org-roam-ui Skip to content Sign up * Why GitHub? Features - + Mobile - + Actions - + Codespaces - + Packages - + Security - + Code review - + Issues - + Integrations - + GitHub Sponsors - + Customer stories- * Team * Enterprise * Explore + Explore GitHub - Learn and contribute + Topics - + Collections - + Trending - + Learning Lab - + Open source guides - Connect with others + The ReadME Project - + Events - + Community forum - + GitHub Education - + GitHub Stars program - * Marketplace * Pricing Plans - + Compare plans - + Contact Sales - + Education - [ ] [search-key] * # In this repository All GitHub | Jump to | * No suggested jump to results * # In this repository All GitHub | Jump to | * # In this organization All GitHub | Jump to | * # In this repository All GitHub | Jump to | Sign in Sign up {{ message }} org-roam / org-roam-ui * Notifications * Star 210 * Fork 3 A graphical frontend for exploring your org-roam Zettelkasten GPL-3.0 License 210 stars 3 forks Star Notifications * Code * Issues 3 * Pull requests 0 * Discussions * Actions * Projects 1 * Wiki * Security * Insights More * Code * Issues * Pull requests * Discussions * Actions * Projects * Wiki * Security * Insights main Switch branches/tags [ ] Branches Tags Could not load branches Nothing to show {{ refName }} default View all branches Could not load tags Nothing to show {{ refName }} default View all tags 3 branches 0 tags Code Clone HTTPS GitHub CLI [https://github.com/o] Use Git or checkout with SVN using the web URL. [gh repo clone org-ro] Work fast with our official CLI. Learn more. * Open with GitHub Desktop * Download ZIP Launching GitHub Desktop If nothing happens, download GitHub Desktop and try again. Go back Launching GitHub Desktop If nothing happens, download GitHub Desktop and try again. Go back Launching Xcode If nothing happens, download Xcode and try again. Go back Launching Visual Studio Code Your codespace will open once ready. There was a problem preparing your codespace, please try again. Latest commit @ThomasFKJorna ThomasFKJorna build: fix the never option crashing ... 197a3c7 Aug 2, 2021 build: fix the never option crashing 197a3c7 Git stats * 244 commits Files Permalink Failed to load latest commit information. Type Name Latest commit message Commit time components fix: selecting never will not throw error anymore Aug 1, 2021 out build: fix the never option crashing Aug 1, 2021 pages fix: made local mode zoom more consistent Aug 1, 2021 public fixed missing links issue Jul 31, 2021 styles file viewer, prettier things Jul 25, 2021 util added pwa compatibility Jul 31, 2021 .editorconfig Apply Prettier Jul 19, 2021 .eslintrc WIP Jul 20, 2021 .gitignore removed logs, maybe included complete build Aug 1, 2021 .prettierrc.js Update graph data when Emacs node changes + minor improvements Jul 23, 2021 2021-07-31 18-17-53.mkv.gif included new build Jul 31, 2021 2021-07-31 18-29-07.mkv.gif included new build Jul 31, 2021 2021-07-31 18-31-11.mkv.gif included new build Jul 31, 2021 2021-07-31 18-32-53.mkv.gif included new build Jul 31, 2021 LICENSE added gpl license Jul 31, 2021 README.md better docstring and readme for custom theme Aug 1, 2021 api.d.ts added filter and orphan toggle Jul 24, 2021 next-env.d.ts WIP Jul 20, 2021 next.config.js removed weird function call Jul 31, 2021 org-roam-ui.el made .el MELPA compatible Aug 1, 2021 package-lock.json forward graphRef to the top component Jul 29, 2021 package.json added pwa compatibility Jul 31, 2021 screenshot.png fixed bug with settingsfetch Jul 16, 2021 tsconfig.json WIP Jul 20, 2021 types.d.ts WIP Jul 20, 2021 yarn.lock added pwa compatibility Jul 31, 2021 View code [ ] org-roam-ui: an org-roam frontend Installation Manually Doom straight /use-package Usage Commands Moving around Configuration Following Updating Theme Disclaimers !! FAQ Q: Graph Slow! Faster? Use a Chromium based browser Turn of the particles Turn off labels Turn off highlight animations Turn off collision Turn off gravity Favor 2D over 3D Don't drag the dang thing around so much! Q: Some of my links are not showing up? Q: Will you implement X? Q: This doesn't work with org-roam v1/org-brain/Zettledelft! Features Cool graph Sliders! Colors Open notes in Emacs Follow your movement in Emacs! Theme syncing Filters 3 D Planned features Graph UI in general Beyond Contribute README.md org-roam-ui: an org-roam frontend image Org-Roam-UI is a frontend for exploring and interacting with your org-roam notes. Org-Roam-UI is meant a successor of 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. 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 M-x package-install websocket Clone the repo: cd ~/.emacs.d/private git clone git@github.com:org-roam/org-roam-ui.git Load in Emacs (add to config): (require 'websocket) (add-to-list 'load-path "~/.emacs.d/private/org-roam-ui") (load-library "org-roam-ui") Doom Add the following to your package.el (package! websocket) (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 (use-package! websocket :after org-roam) (use-package! org-roam-ui :after org-roam ;; or :after org :hook (org-roam . org-roam-ui-mode) :config ) 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 (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-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 ORUI provides a few commands for interacting with the graph without ever having to leave Emacs. NOTE: This is quite janky at the moment and will change in the future. Consider this more of a teaser. Moving around (orui-node-zoom) Zooms to the current node in the global view ignoring local mode. (orui-node-local) Opens the current node in local view. You can optionally give these command three parameters: 1. the node id you want to zoom to (by default the current node) 2. The speed at which you want to zoom (can be set in the UI) in ms. 3. The padding of the zoom in px. These options might not work at the moment, please configure them in the UI for the time being. Configuration Org-Roam-UI exposes a few variables, but most of the customization is done in the web app. Following ORUI follows you around Emacs by default. To disable this, set (setq org-roam-ui-follow nil) or disable the minor mode org-roam-ui-follow-mode. Updating We plan to make updates to the graph happen smoothly, at the moment it is only possible to reload the entire graph when an update happens (but local mode is preserved). This is enabled by default, to disable (setq org-roam-ui-update-on-save nil) Theme Org-Roam-UI can sync your Emacs theme! This is the default behavior, to disable it do (setq org-roam-ui-sync-theme nil) Then call M-x orui-sync-theme. You can also provide your own theme if you do not like syncing nor like the default one. To do so, set org-roam-ui-custom-theme to an alist of (rather specific) variables, like so (setq org-roam-ui-custom-theme (list (bg . "#1E2029") (bg-alt . "#282a36") (fg . "#f8f8f2") (fg-alt . "#6272a4") (red . "#ff5555") (orange . "#f1fa8c") (yellow ."#ffb86c") (green . "#50fa7b") (cyan . "#8be9fd") (blue . "#ff79c6") (violet . "#8be9fd") (magenta . "#bd93f9"))) 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. Disclaimers !! * We only support org-roam v2; v1 will never be supported. * As the name suggests, Org-Roam-UI only works with org-roam! If you organize your notes in some other form org-roam-ui cannot work, as it uses org-roam to fetch all the connections. * Feature-parity with org-roam-server is not the goal. Although we aim to make a similar product which is having a visual graph to help you explore and navigate your org-roam nodes, we do not intend to replicate all of the, nor be limited to replicating the features of org-roam-server. * This is alpha software: please do give it a try and use it, but expect bugs and troubleshooting! * The project was created by a couple of tinkerers to scratch their own itch. We don't get rewarded in any material way and development may stop any day (because life). The best way to keep the project alive is to explore the code and contribute! FAQ Q: Graph Slow! Faster? While we try to optimize the display of the graph, there is only so much we can do. For largish networks (>2k nodes) dragging the graph around a lot can cause some performance issues, but there are a few things you can do to speed it up. Use a Chromium based browser As much as it saddens us to say, Firefox's rendering engine is quite a bit slower than its Chromium cousins. Compare the performance of the two and see if that's the main issue first. Turn of the particles I know, very cool to see those little guys travel up and down your notes, but very slow, especially in 3D mode. Turn off labels Probably the second slowest thing to render, with little possibility of speeding it up. Consider only turning on labels on highlight or cranking up the "Label appearance scale". Turn off highlight animations I know, they're gorgeous, but not very performant. Turn off collision Nice, but costly! If you like to have the graph more spread out, turning off collision will change little in the resulting layout, but will help performance quite a bit. Turn off gravity Fewer forces fewer worries Favor 2D over 3D I know, it looks cool, but man is it slow. Don't drag the dang thing around so much! In our experience, once the graph has actually settled and nothing needs to be rendered again, looking around should pose little trouble. At the moment there is no way of "saving" the graph configuration, but we are exploring the possibility. The graph layout algorithm is deterministic however, so barring any changes to the data it should produce the same results each time. Q: Some of my links are not showing up? At the moment we aren't showing citation links made with org-roam-bibtex yet, but we will soon! 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! Q: This doesn't work with org-roam v1/org-brain/Zettledelft! 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 Sliders! Configure the graph just the way you like it. image Colors A ton image or just a splash. image 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! 2021-07-31.18-16-52.mkv.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. 2021-07-31.18-17-19.mkv.mp4 Theme syncing Your gruvbox is only a M-x orui-sync-theme away. 2021-07-31.18-26-01.mkv.mp4 Filters 2021-07-31.18-29-12.mkv.mp4 3 D Literally deepen your understanding of your thoughts (and it looks cool) 2021-07-31.18-32-53.mkv.mp4 Planned features Graph 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 UI in general * File viewing using AST parsing * Displaying notes Andy Matushak style * Discovery options, e.g. "show shortest path between X and Y" Beyond * Discuss the future of org-roam-ui with us here! Contribute git clone https://github.com/org-roam/org-roam-ui yarn yarn dev GitHub Community Guidelines apply. Go here to have an onboarding call with a member of the core team. We would [?] to have you on board. About A graphical frontend for exploring your org-roam Zettelkasten Topics react d3 typescript emacs org-mode zettelkasten org-roam Resources Readme License GPL-3.0 License Releases No releases published Packages 0 No packages published Contributors 3 * @ThomasFKJorna ThomasFKJorna Thomas F. K. Jorna * @kirillrogovoy kirillrogovoy Kirill Rogovoy * @shaunsingh shaunsingh Languages * JavaScript 97.4% * TypeScript 1.6% * Other 1.0% * (c) 2021 GitHub, Inc. * Terms * Privacy * Security * Status * Docs * Contact GitHub * Pricing * API * Training * Blog * About You can't perform that action at this time. You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.