bmad-index-docs

Generate or update folder-wide index.md files with relative links.

Updated Mar 24, 2026
One-click install
npx skills add https://github.com/imonmi/INTER-EDU --skill bmad-index-docs-imonmi
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bmad-index-docs
Source: https://github.com/imonmi/INTER-EDU/tree/main/_bmad/core/skills/bmad-index-docs
Command: npx skills add https://github.com/imonmi/INTER-EDU --skill bmad-index-docs-imonmi

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Manually locating and navigating documentation across a folder is time-consuming; this Skill creates or refreshes an index that references every document for fast discovery and publishing.

Core Features & Use Cases

  • Generate a new index.md that lists all files in the target folder with concise descriptions.
  • Update an existing index.md when files are added, removed, or renamed to keep navigation accurate.
  • Organize entries and provide relative links to simplify sharing and documentation reviews.

Quick Start

Run this Skill on a target folder to create or update its index.md.

Frequently Asked Questions about bmad-index-docs

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

FAQPage Schema
How do I generate a markdown index for all files in a documentation folder?

To generate a markdown index for a documentation folder, you can use an automated tool that scans the directory, groups files by type, generates per-file descriptions, and writes a standardized index.md using relative links.

How do I update an existing index.md when documentation files are renamed or removed?

To update an existing index.md when files change, run the indexing process on the target directory to refresh the navigable index, ensuring all entries and relative links accurately reflect the current folder contents.

What is the best way to create a navigable index for markdown documentation?

The best way to create a navigable index for markdown documentation is to scan the folder, group files by type, and generate a standardized index.md with concise descriptions and relative links to simplify discovery and publishing workflows.

Can I organize folder documentation entries by file type in an index file?

Yes, you can organize folder documentation entries by file type in an index file. The indexing process scans the directory and groups files by type before writing the standardized index.md with relative links.

Do I need any external dependencies to auto-index markdown files in a folder?

No, you do not need any external dependencies to auto-index markdown files in a folder. The Skill operates independently to scan directories, group files, generate descriptions, and write the index.md file.

When should I avoid using an automated folder-wide index for documentation?

You should avoid using an automated folder-wide index for documentation if your directory contains non-documentation files, as the tool is designed specifically for directories where navigable indexes improve accessibility and publishing workflows.