org-roam.nvim

Port of Org-roam to neovim using nvim-orgmode.

Main branch requires neovim 0.11.0+. For all tagged versions, see installation table to find the supported neovim version.

This plugin depends on nvim-orgmode/orgmode 0.7.0 or newer.

It is recommended to install and maintain the latest version of orgmode, or lock into the commit that this plugin needs, which is illustrated below.

{
  "chipsenkbeil/org-roam.nvim",
  tag = "0.2.0",
  dependencies = {
    {
      "nvim-orgmode/orgmode",
      tag = "0.7.0",
    },
  },
  config = function()
    require("org-roam").setup({
      directory = "~/org_roam_files",
      -- optional
      org_files = {
        "~/another_org_dir",
        "~/some/folder/*.org",
        "~/a/single/org_file.org",
      }
    })
  end
}

use {
  "chipsenkbeil/org-roam.nvim",
  tag = "0.2.0",
  requires = {
    {
      "nvim-orgmode/orgmode",
      tag = "0.7.0",
    },
  },
  config = function()
    require("org-roam").setup({
      directory = "~/orgfiles",
    })
  end
}

NOTE: All dailies keybindings are global

See DOCS.org for detailed guidance on the plugin.

The documentation is also generated in vimdoc help format, which can be accessed via :h org-roam.txt.

A collection of features to implement in no particular order.

• [-] Implement org-roam buffer
  • [X] Implement org-roam-buffer-toggle (tracks current node at point)
  • [X] Implement org-roam-buffer-display-dedicated (tracks specific node)
  • [X] Implement Backlinks widget for buffer
    • View (preview of) nodes that link to this node
  • [ ] Implement Reference Links widget for buffer
    • Nodes that reference this node (see Refs)
  • [ ] Implement Unlinked references widget for buffer
    • View nodes that contain text that match the nodes title/alias but are not linked
  • [X] Implement Origin widget for buffer (custom, not in Org Roam!)
    • Displays the origin of the node as defined in ROAM_ORIGIN
• [ ] Support citations
  • [ ] As of orgmode 9.5, org-cite is built-in and has the form [cite:@key]
  • [ ] Alongside org-cite, there is also support for org-ref (v2 & v3), which uses cite:key as its format
• [X] Support completion
  • [X] Completing within Link Brackets
  • [X] Completing anywhere
• [X] Support templating
  • [X] Implement org-roam-node-insert
  • [X] Implement org-roam-node-find
  • [X] Implement org-roam-capture
  • [X] Implement org-roam-node-insert-immediate
• [X] Support origin (custom, not in Org Roam!)
  • [X] ROAM_ORIGIN available within node properties, containing org id
  • [X] Ability to query database for nodes with origin matching an id
  • [X] Keybinding to jump forward and backward across origins
• [X] Miscellaneous Roam functions
  • [X] Implement org-roam-alias-add
  • [X] Implement org-roam-alias-remove
  • [X] Implement org-roam-origin-add (custom, not in Org Roam!)
  • [X] Implement org-roam-origin-remove (custom, not in Org Roam!)
• [-] Implement extensions
  • [X] org-roam-dailies
  • [ ] org-roam-export
  • [ ] org-roam-graph
  • [ ] org-roam-protocol

A makefile is provided to support running tests. It will download plenary.nvim and nvim-orgmode into the vendor directory.

make test