/org-roam.nvim

Rudimentary org-roam replica for neovim

Primary LanguageLuaMIT LicenseMIT

org-roam.nvim

Under development, no way near usable

This plugin tries to have one to one feature parity with the original org-roam

If you are new to this checkout the org-roam manual

Installation with packer

use({
    "SyedFasiuddin/org-roam.nvim",
    config = function ()
        local org_roam = require("org-roam")
        org_roam.setup({
            -- required
            org_roam_directory = "~/OrgRoam",

            -- required (not checked if present)
            org_roam_database_file = "~/.config/emacs/org-roam.db"
        })

        vim.keymap.set("n", "<Leader>nf", org_roam.org_roam_node_find)
        vim.keymap.set("n", "<Leader>nc", org_roam.org_roam_capture)
    end,
    requires = { "kkharji/sqlite.lua" }
})

Installation with lazy.nvim

{
    "SyedFasiuddin/org-roam.nvim",
    dependencies = { "kkharji/sqlite.lua" },
    opts = {
        -- required
        org_roam_directory = "~/OrgRoam",
        -- required (not checked if present)
        org_roam_database_file = "~/.config/emacs/org-roam.db"
    },
    keys = {
        {
            "<Leader>nf",
            "<Cmd>lua require(\"org-roam\").org_roam_node_find()<CR>",
        },
        {
            "<Leader>nc",
            "<Cmd>lua require(\"org-roam\").org_roam_capture()<CR>",
        },
    },
}

What features are supported?

  • Find node: org_roam_node_find
  • Capture node: org_roam_capture