Verified:Website 𝕏@devalexanderdaz GitHub

bmad-index-docs

Generate index.md files cataloging documentation with content-based descriptions.

Updated May 5, 2026

Search Tags:#documentation #markdown #content-management #folder-organization #index-generation #file-cataloging #auto-index

Ready to run

npx skills add https://github.com/devalexanderdaza/bmad-any --skill bmad-index-docs-devalexanderdaza

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: bmad-index-docs
Source: https://github.com/devalexanderdaza/bmad-any/tree/main/.agents/skills/bmad-index-docs
Command: npx skills add https://github.com/devalexanderdaza/bmad-any --skill bmad-index-docs-devalexanderdaza

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Manually creating and maintaining index.md files for folders with multiple documentation files is time-consuming, error-prone, and often results in outdated or inaccurate descriptions that don't reflect actual file content.

Core Features & Use Cases

Content-Aware Descriptions: Reads each file's actual content to generate accurate 3-10 word descriptions instead of guessing from filenames.
Organized Grouping: Automatically groups files by type and subdirectory, with alphabetical sorting within each group for easy navigation.
Use Case: You have a project knowledge base folder with 30+ markdown and reference files. Use this skill to quickly generate an up-to-date index so team members can find the right resource without scrolling through unstructured file lists.

Quick Start

Use the bmad-index-docs skill to generate an index of all files in your project's ./docs/guides 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 auto-generate an index.md file for a documentation folder?▼

To auto-generate folder documentation indexes, this skill reads individual file contents to produce accurate short descriptions, organizing entries by file type and subdirectory with alphabetical sorting and relative path formatting.

What is the best way to catalog markdown files in a project knowledge base?▼

Cataloging markdown files in a project knowledge base is done by scanning target folders and generating an index.md file that groups resources by type and subdirectory, creating 3-10 word content-aware descriptions for easy navigation.

How does content-aware index generation work for directory listings?▼

Content-aware index generation works by reading the actual contents of each file in a target directory, rather than just filenames, to extract accurate short descriptions for the catalog entries in the index.md file.

Can I organize file catalog entries by subdirectory and file type?▼

Yes, you can organize file catalog entries by subdirectory and file type. The generated index.md automatically groups files into these categories and enforces alphabetical sorting within each group for structured navigation.

Does auto-indexing update existing documentation indexes or only create new ones?▼

Auto-indexing both generates and updates index.md files to ensure directory listings reflect current file resources. It reads file contents and applies relative path formatting and alphabetical sorting per defined validation rules to maintain accuracy.

Do I need any external dependencies to generate folder documentation indexes?▼

No external dependencies are required to generate folder documentation indexes. The skill operates independently to read file contents, produce short descriptions, and organize directory listings by file type and subdirectory.