NORMAL ~/wkd/p/docmap :set skin=modern utf-8

docmap.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.11+
repo
github.com/WKDSteve/docmap.nvim
commits
759
help
:help docmap

demo

recorded with VHS from demos/docmap.tape in a clean Neovim — re-recorded weekly
what is shown when
  1. :DocMap mermaid tree - the module tree of the repo you are in
  2. :DocMap mermaid deps - the require graph, ready for a README

install

{
  "WKDSteve/docmap.nvim",
  opts = {},
}

also as

  • native app: docmap-desktop — A desktop workspace for the module maps docmap.nvim generates: add several projects, look at any of them, switch between them quickly.

docs/

git log

  1. fix scan: remember one parsed tree per grammar, not every tree
  2. perf scan: parse each source once per scan, find comments and calls by query
  3. refactor mcp: serve through lib.nvim.mcp.server
  4. test config: drop the stale telemetry entry from guard_allow.fs
  5. test telemetry: clear the store where runtime-analysis keeps it now
  6. fix standalone: the shim's vim.fn.system runs git formats with % on Windows the git_run way
  7. fix ci: the standalone gate skips the history routes where git cannot read HEAD
  8. fix standalone: git_run moves --pretty=<placeholders> too, and its temp file name differs per process
  9. fix release: the shape probe reads the committed map, and a route probe that misses its module stops the build
  10. fix standalone: git formats with % run on Windows through a named pretty format
  11. docs regenerate the connection pictures (optional loads through probe/safe/package.loaded)
  12. fix test: api_spec's no-map check does not read the machine's rules vault

keys

j / k
next / previous line
gg / G
first / last line
⏎
open the line under the cursor
/
search plugins and apps (app: x or plugin: x narrows)
:
command line — Tab completes
:help x
vimdoc of a plugin (:e x = plugin page)
:ls · :apps · :play · :log · :stack
plugin list · app list · play area · activity stream · dependency graph
:log apps
the stream of one area (plugins or apps)
:colo x
colorscheme
:set skin=
modern | tui
?
this help
esc
close