Project & repos · beta · Neovim 0.10+ · 455 commits
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.
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 = {},
}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.
Documentation
- docs/BINDINGS.md
- docs/CONTRIBUTING.md
- docs/DEVELOPMENT.md
- docs/FEATURE_LOG.md
- docs/README.md
- docs/SECURITY.md
- docs/WORKFLOW.md
- docs/annotation_tags.md
- docs/annotations.md
- docs/api.md
- docs/around-it.md
- docs/call_hierarchy.md
- docs/checklist_format.md
- docs/commands.md
- docs/configuration.md
- docs/ecosystem.md
- docs/features_format.md
- docs/framework_conventions.md
- docs/health.md
- docs/hosting.md
- docs/hover.md
- docs/installation.md
- docs/integrations.md
- docs/languages.md
- docs/mcp.md
- docs/pipeline.md
- docs/quickstart.md
- docs/requirements.md
- docs/reuse.md
- docs/tabs.md
- docs/what-you-get.md
Recent commits
- fix standalone: glob's ** no longer follows symlink loops, sorts on precomputed keys
- fix standalone: shell_quote refuses % on the Windows branch
- fix standalone: glob ignores case on macOS too, not only on Windows
- feat standalone: the vim shim runs rules.nvim's engine, and fixes the standalone build broken by lib.nvim (L10 P1)
- · Merge branch 'claude/github-stats-traffic-985834'
- feat browse: add traffic mode, joined against github_stats.nvim's digest
- docs the queue is no longer linked, it lives in the author's notes
- docs link back to the wkd family site