Neorg Archive

Create and manage an archival workspace for your Neorg notes.

Installing

This module depends on neorg-interim-ls. Note the temporary nature of interim-ls, this plugin will be updated once an official Neorg LSP is created.

Rocks.nvim 🗿

:Rocks install neorg-archive

Lazy.nvim

-- neorg.lua
{
    "nvim-neorg/neorg",
    lazy = false,
    version = "*",
    config = true,
    dependencies = {
        { "bottd/neorg-archive" }
    }
}

Config

Two configuration steps are required. First, add an archive workspace:

require("neorg").setup({
    load = {
        ["core.dirman"] = {
            config = {
                workspaces = {
                    archive = "path/to/your/archive",
                },
            },
        },
        ["external.interim-ls"] = {
        -- find interim-ls options here:
        -- https://github.com/benlubas/neorg-interim-ls?tab=readme-ov-file#install
        },
        ["external.archive"] = {
        -- default config
            config = {
                -- (Optional) Archive workspace name, defaults to "archive"
                workspace = "archive",
                -- (Optional) Enable/disable confirming archive operations
                confirm = true
            }
        }
    },
})

Usage

The archive module adds the following commands:

:Neorg archive archive-file

Moves the currently opened file to the archive: archive-workspace/workspace-name/path-to-file

:Neorg archive restore-file

Moves an archived file back to it's workspace from archive-workspace/workspace/file.norg to workspace/file.norg