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-code

Installs 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 GitHub

Sponsors

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
1existential-birds avataradr-writingexistential-birds/beagleUse when writing or formatting an ADR document using the MADR template, applying Definition of Done (E.C.A.D.R.) criteria, or verifying ADR completeness. Trigge250skills.sh installs
2nexu-io avatarblog-postnexu-io/open-designA long-form article / blog post — masthead, hero image placeholder, article body with figures and pull quotes, author byline, related posts. Use when the brief 245skills.sh installs
3shino369 avatardocument-writingshino369/claude-code-personal-workspaceExpert knowledge in document and essay writing conventions for English, Japanese, and Chinese (Traditional). Use when writing or translating formal documents, e241skills.sh installs
4nansen-ai avatarnansen-agent-guidenansen-ai/nansen-cliRouting guide -- when to use `nansen agent` (AI research) vs direct CLI data commands. Use when deciding how to answer a user's research question with Nansen to240skills.sh installs
5yunshu0909 avatarwriting-assistantyunshu0909/yunshu_skillshub写作助手 - 当用户说"我想写XX"、"帮我梳理选题"、"怎么形成框架"、"给我组织思路"时触发。根据观点清晰度自动选择最优路线:清晰观点走"框架→内容",模糊观点走"挖掘→选题→框架→内容"。239skills.sh installs
6ncklrs avatardemo-specialistncklrs/startup-os-skillsExpert product demonstration specialist for SaaS and B2B software. Use when preparing demos, structuring demo presentations, tailoring to stakeholders, handling229skills.sh installs