bmad-index-docs

Generate or update an index.md file listing documentation files with descriptions.

Updated Mar 16, 2026
One-click install
npx skills add https://github.com/JohnnyWang1998/job-market-tracker --skill bmad-index-docs-johnnywang1998
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bmad-index-docs
Source: https://github.com/JohnnyWang1998/job-market-tracker/tree/main/_bmad/core/skills/bmad-index-docs
Command: npx skills add https://github.com/JohnnyWang1998/job-market-tracker --skill bmad-index-docs-johnnywang1998

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the creation and updating of an index file for all documentation within a specified folder, making it easier to navigate and understand project resources.

Core Features & Use Cases

  • Automated Indexing: Generates a Markdown file listing all files and subdirectories.
  • Content Summarization: Creates brief descriptions for each file based on its content.
  • Use Case: After adding new design documents to a /designs folder, run this Skill to automatically update designs/index.md with links and descriptions of all new files.

Quick Start

Use the bmad-index-docs skill to create or update an index.md file for the ./docs folder.

Frequently Asked Questions about bmad-index-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automatically generate an index for markdown documentation?

To automatically generate an index for markdown documentation, use this Skill to scan a specified folder and create an index.md file. It organizes files by type and subdirectory while adding concise descriptions based on content.

Can I update an existing index.md file after adding new documents?

Yes, you can update an existing index.md file after adding new documents. Running this Skill regenerates or updates the index to include links and brief descriptions for all newly added files in the folder.

Does automated documentation indexing work with nested subdirectories?

Automated documentation indexing does work with nested subdirectories. The Skill organizes discovered content by file type and subdirectory, creating a structured index.md that reflects your folder hierarchy.

How are file descriptions generated during the markdown indexing process?

During the markdown indexing process, file descriptions are generated automatically based on the actual content of each file. This ensures the index.md entries provide concise summaries for easy resource discovery.

What is the best way to organize project documentation for automated discovery?

The best way to organize project documentation for automated discovery is grouping files into folders by type. This Skill then scans the directories, summarizing content and generating a structured index.md for navigation.

Are there limitations when indexing large file management directories?

A limitation when indexing large file management directories is that the Skill relies on basic internal processing to scan content and generate summaries. Extremely large folders may take longer to process when creating the index.md file.