     _                                       _        _   _
  __| | ___   ___ _   _ _ __ ___   ___ _ __ | |_ __ _| |_(_) ___  _ __
 / _` |/ _ \ / __| | | | '_ ` _ \ / _ \ '_ \| __/ _` | __| |/ _ \| '_ \
| (_| | (_) | (__| |_| | | | | | |  __/ | | | || (_| | |_| | (_) | | | |
 \__,_|\___/ \___|\__,_|_| |_| |_|\___|_| |_|\__\__,_|\__|_|\___/|_| |_|
                                                                  .nvim

documentation.nvim

Point it at a repository and it produces a module map: an interactive HTML page, a Markdown overview, a deterministic JSON artifact, and a set of drift checks that fail CI when the documentation and the code stop agreeing.

status: beta — Beta stage — active development. This repository is past its first shape and in active use, but the surface is not frozen: breaking changes are still possible. Pin a commit or tag if you depend on it.
category: Project & repos
neovim: 0.10+
repo: github.com/StefanBartl/documentation.nvim
commits: 455
help: :help documentation

demo

recorded with VHS from demos/documentation.tape in a clean Neovim — re-recorded weekly

what is shown when

:DocMap mermaid tree - the module tree of the repo you are in
:DocMap mermaid deps - the require graph, ready for a README

install

{
  "StefanBartl/documentation.nvim",
  opts = {},
}

docs/

git log

2026-10-02 fix standalone: glob's ** no longer follows symlink loops, sorts on precomputed keys
2026-10-02 fix standalone: shell_quote refuses % on the Windows branch
2026-10-02 fix standalone: glob ignores case on macOS too, not only on Windows
2026-10-02 feat standalone: the vim shim runs rules.nvim's engine, and fixes the standalone build broken by lib.nvim (L10 P1)
2026-10-01 · Merge branch 'claude/github-stats-traffic-985834'
2026-10-01 feat browse: add traffic mode, joined against github_stats.nvim's digest
2026-09-25 docs the queue is no longer linked, it lives in the author's notes
2026-09-24 docs link back to the wkd family site
2026-09-22 docs map: regenerate module map [skip ci]
2026-09-22 fix config: move repo_url/branch derivation out of build(), into scan()
2026-09-22 docs map: regenerate module map [skip ci]
2026-09-22 feat config: auto-derive repo_url/branch from the real git remote (GS-16)