bmad-index-docs

Generate an index.md listing files and subdirectories with relative paths.

Updated Apr 12, 2026
One-click install
npx skills add https://github.com/clovernguyen1010-ship-it/Clover_Nguyen --skill bmad-index-docs-clovernguyen1010-ship-it
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bmad-index-docs
Source: https://github.com/clovernguyen1010-ship-it/Clover_Nguyen/tree/main/_bmad/core/bmad-index-docs
Command: npx skills add https://github.com/clovernguyen1010-ship-it/Clover_Nguyen --skill bmad-index-docs-clovernguyen1010-ship-it

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generates or updates an index.md to reference all docs in a target folder, saving time and avoiding manual curation.

Core Features & Use Cases

  • Automatically scans a folder to discover files and subdirectories.
  • Groups items by type and subfolder to create an organized index.
  • Produces concise, accurate descriptions and updates an existing index.md when present.

Quick Start

Use the skill to generate or update index.md for a target folder by listing its contents and compiling an organized, annotated index.

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 a markdown index for a folder of documents?

To generate a markdown index automatically, you can scan the target directory to list files and subdirectories, group items by type or subfolder, and assemble a concise, annotated index.md with relative paths.

What is the best way to organize a directory index by file type and subfolder?

Organizing a directory index by file type and subfolder involves scanning the target path, grouping similar files together, generating concise descriptions for each item, and validating the structure before writing the final index.md.

Can I update an existing index.md file instead of recreating it from scratch?

Yes, you can update an existing index.md file by scanning the current directory structure and modifying the existing document to reflect new files and subdirectories while preserving the organized, annotated format.

How do I create an annotated table of contents for markdown documentation?

Creating an annotated table of contents for markdown documentation requires scanning your folder for all files, grouping them by subdirectory, producing brief descriptions, and compiling these elements into a cohesive index.md.

Does this directory indexing tool work with relative paths for markdown files?

Yes, the directory indexing process ensures all generated references in the index.md file use relative paths, allowing the markdown documentation to maintain correct internal linking regardless of the root folder location.