docs-index-keeper

What problem does it solve?

docs-index-keeper prevents missed or outdated entries in a repository’s Markdown docs index (commonly docs/README.md) by automatically updating the table as new or changed docs are added.

Core Features & Use Cases

• Pre-commit and CI-friendly indexing: Install once to update docs index tables on staged Markdown changes and use a CI check that fails when the index is out of date.
• Staged-file driven updates: Updates and checks operate on staged .md files so the index stays aligned with what’s actually going into the next commit.
• Manual bulk indexing: Add one or many docs entries, including via quoted glob-like masks, so maintainers don’t edit index rows by hand.
• Purpose extraction from headings: Populates the index “Purpose” column using the first Markdown heading in each doc (or a sensible fallback from the filename).

Quick Start

Run this instruction: Install docs-index-keeper in the repo and then initialize it with npx docs-index-keeper init so future pre-commit runs keep docs/README.md updated automatically.