
Bmad Index Docs
This generates or updates an index.md file that catalogs everything in a directory. It scans the folder, reads each file to understand what it actually does, then writes out an organized markdown index with brief descriptions and relative links. The smart bit is that it generates descriptions from actual content rather than guessing from filenames, keeping things accurate in 3 to 10 words per entry. Files get grouped by type or subdirectory and sorted alphabetically. Useful when you've got a docs folder that's grown organically and you need a proper table of contents without manually maintaining one. Skips hidden files by default unless you specify otherwise.
- skills.sh installs
- 259
- GitHub stars
- 55.2K
- last updated
- Aug 21, 2026
Install
$ npx -y skills add bmad-code-org/bmad-method --skill bmad-index-docs --agent claude-codeInstalls into .claude/skills of the current project.
Files
This generates or updates an index.md file that catalogs everything in a directory. It scans the folder, reads each file to understand what it actually does, then writes out an organized markdown index with brief descriptions and relative links. The smart bit is that it generates descriptions from actual content rather than guessing from filenames, keeping things accurate in 3 to 10 words per entry. Files get grouped by type or subdirectory and sorted alphabetically. Useful when you've got a docs folder that's grown organically and you need a proper table of contents without manually maintaining one. Skips hidden files by default unless you specify otherwise.
Browse the repository on GitHubSponsors
Details
- Repository
- github.com/bmad-code-org/bmad-method
- Categories
- Documentation, Marketing & SEO
- First seen
- Jun 3, 2026
More from bmad-code-org/bmad-method
All 41- Bmad Create Ux Design181
- Bmad Distillator163
- Bmad Code Review15.5K
- Bmad Agent Architect15.1K
- Bmad Brainstorming15.1K
- Bmad Agent Pm15.1K
- Bmad Agent Dev15K
- Bmad Agent Analyst15K
- Bmad Agent Ux Designer14.9K
- Bmad Advanced Elicitation14.6K
- Bmad Qa Generate E2e Tests14.6K
- Bmad Party Mode14.5K
- Bmad Product Brief14.4K
- Bmad Prfaq14K
- Bmad Retrospective11.7K
- Bmad Correct Course9.8K
- Bmad Create Epics And Stories3.2K
- Bmad Sprint Planning3.2K
- Bmad Help502
- Bmad Generate Project Context449
- Bmad Create Prd390
- Bmad Create Architecture387
- Bmad Document Project359
- Bmad Create Story355