Generate or update docs/README.md index rows from staged Markdown files.
npx skills add https://github.com/oleg-koval/docs-index-keeper --skill docs-index-keeper
Please help me install this Agent Skill. Skill: docs-index-keeper Source: https://github.com/oleg-koval/docs-index-keeper/tree/main Command: npx skills add https://github.com/oleg-koval/docs-index-keeper --skill docs-index-keeper
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.
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.
High-intent search queries and answers about installing and using this skill.
To automatically update a Markdown documentation index in Git, use a pre-commit hook that reads staged Markdown files and inserts missing table rows into docs/README.md. This keeps your index synced with committed changes without manual editing.
Keeping a docs README table synchronized is best handled by CI enforcement that fails non-zero when the index is outdated. It scans staged Markdown inputs, filters to a configurable docs directory, and extracts purpose from the first heading to populate rows.
Yes, you can use a pre-commit hook to manage docs index table entries. Install the hook once, and it will automatically generate or update docs/README.md rows based on newly added or changed Markdown files during the staging process.
Yes, you need Node.js 18 or higher to run this Markdown indexing automation in CI. The tool requires this environment to read staged Markdown inputs, apply directory excludes, and insert missing entries into a compatible Markdown table.
To add multiple Markdown files to a docs index at once, use manual bulk indexing with quoted glob-like path masks. This allows maintainers to insert many documentation entries into the index table simultaneously without editing rows by hand.
team-attentionReview Markdown content through an interactive web UI.
atframeworkValidate repository root configurations and dependencies across build, lint, and CI changes.
EojEdredScan code and configurations for security vulnerabilities and replay risks.
cosmixFix alignment and spacing issues in Markdown tables.
