neorg-indent

Neorg module for hierarchical indentation of norg files.

Features

• Heading indentation — content under headings is indented based on heading depth
• List indentation — unordered (-) and ordered (--) lists indent according to nesting level
• Continuation line alignment — wrapped lines in list items align with the content start

Installation

Install Neorg (via your Neovim plugin manager) first. This rockspec does not pull Neorg from LuaRocks, so it will rely on your local Neorg checkout.

Install with LuaRocks from the rockspec:

luarocks make --local neorg-indent-scm-1.rockspec

Then load the module in your Neorg config:

require("neorg").setup({
    load = {
        ["core.defaults"] = {},
        ["external.indent"] = {},
    },
})

Configuration

Option	Default	Description
indent_per_level	4	Spaces per indentation level (fallback)
heading_indent	nil	Per-heading-level indent table, e.g. { [1]=4, [2]=4 }
list_indent	nil	Per-list-nesting-depth indent table, e.g. { [1]=4, [2]=4 }

When heading_indent[n] or list_indent[n] is not set for a given level, indent_per_level is used as the fallback.

["external.indent"] = {
    config = {
        indent_per_level = 4,
    },
},

Custom per-level spacing example:

["external.indent"] = {
    config = {
        indent_per_level = 4,
        heading_indent = { [1] = 2, [2] = 4, [3] = 4 },
        list_indent = { [1] = 2, [2] = 2 },
    },
},

With this config, content under h1 > h2 > h3 gets 2 + 4 + 4 = 10 spaces of indent, and a list nested two levels deep adds 2 + 2 = 4 spaces on top of any heading indent.

Development

Run tests:

make test

By default the tests look for Neorg under:

~/.local/share/nvim/lazy/neorg/lua

Override with NEORG_DIR if your Neorg install lives elsewhere:

NEORG_DIR=/path/to/neorg/lua make test

If nvim-treesitter is not under the standard Lazy path, set:

NVIM_TREESITTER_DIR=/path/to/nvim-treesitter make test

Check formatting:

make format

Limitations

Minimum indent of 1 for h1 content

Content under h1 has a minimum indent of 1 space, even with heading_indent = { [1] = 0 }. This is because Neovim's concealer replaces the * marker with a single-character icon (e.g. ◉), placing the heading text at column 1. The 1-space indent keeps body text aligned with the heading text after the icon.

License

MIT