CaryWill / org-roam-ui.nvim

A graphical frontend for exploring your org-roam Zettelkasten

Note

./demo.mp4

This is a fork of org-roam-ui, thanks to the great work of the org-roam-ui author, what I only need to do, is feed the data to the frontend webpage. which means, I only need to develop a plugin for neovim istead of emacs, like the org-roam-ui.el file do.

And CaryWill/org-roam.nvim is also a forked project.

Installation

1. install this neovim plugin.

Plug ‘CaryWill/org-roam-ui.nvim’ Plug ‘CaryWill/org-roam.nvim’

1. globally install neovim npm package.

I tried to use lua websocket module, but it’s so hard to install, so I quit, I used nodejs to develop neovim org-roam-ui server.

so please run to install neovim node host: `npm install -g neovim`

1. start up the frontend page.

Go to your neovim plugin directory and cd into `org-roam-ui.nvim` then run `npm install –force` then `npm run dev` to start the frontend page. Mine is in: ~/.local/share/nvim/plugged

1. make org-roam websocket connect to your org-roam-ui

run in vim command line: :InitWs

What is Supported?

It only support the graph view and note view for now, because it’s the only thing I needed for now, PR are welcome.

1. You can view notes in the web browser.(image also)

Changelog

For major new features/bugfixes we will update [changelog](org-roam#30).

Related Repos

1. org-roam-ui-neovim-server
2. org-roam-ui
3. org-roam
4. dotfile plugin path

Supported features

• [X] org-roam-ui ws support and when connected the graph view will be inited.
• [X] Http server to view file content
• [ ] doc, like recommand plugin keymapping to init ws
• [X] move org-roam-ui-server nodejs neovim plugin to org-roam-ui repo
• [X] file change watch and update org-roam-ui
• [ ] how to open org-roam-ui effectively, write a vim command, write a command to start up this page and call :InitWs

BUG

• [X] I found some notes are not shown, like W54, maybe it is not created with org roam, thus no org id property?