bmad-index-docs

Generate an index.md file listing documents by type and subdirectory.

Updated Mar 16, 2026

Search Tags:#documentation #markdown #indexing #file management #organization

Ready to run

npx skills add https://github.com/deltatree/wissensmanagement --skill bmad-index-docs-deltatree

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: bmad-index-docs
Source: https://github.com/deltatree/wissensmanagement/tree/main/_bmad/core/skills/bmad-index-docs
Command: npx skills add https://github.com/deltatree/wissensmanagement --skill bmad-index-docs-deltatree

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the creation or updating of an index file for all documents within a specified folder, making it easier to navigate and understand the contents of a directory.

Core Features & Use Cases

Automated Indexing: Scans a directory and generates a Markdown file listing all files and subdirectories.
Content-Aware Descriptions: Reads files to create concise, informative descriptions based on their content.
Use Case: After adding new design assets to a project folder, use this Skill to quickly generate an updated index.md that details each asset and its purpose.

Quick Start

Use the bmad-index-docs skill to create an index of all files in the ./assets/images 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 a markdown index for all files in a folder?▼

To generate a markdown index for a folder, you need an automated tool that scans the directory and creates an index.md file listing all documents and subdirectories. This Skill automates that exact process by organizing content alphabetically with relative paths.

Can I create content-aware descriptions for markdown files automatically?▼

Creating content-aware descriptions for markdown files automatically requires reading each document to generate concise summaries. This Skill reads file contents and produces brief, informative descriptions based on the actual text within each indexed item.

What is the best way to organize documentation by type and subdirectory?▼

Organizing documentation by type and subdirectory is achieved by generating an index.md file that categorizes items hierarchically. This Skill scans your folders, skips hidden files, and structures all references by content type and their subdirectory location.

Does this directory indexing tool skip hidden files and validate relative paths?▼

Yes, this directory indexing tool skips hidden files and validates output using relative paths. It ensures your generated index.md file only references visible documents and correctly links them using validated relative path structures for accurate navigation.

How do I update an existing index.md file after adding new documents?▼

Updating an existing index.md file after adding new documents involves re-scanning the directory to apply alphabetical sorting and generate new descriptions. This Skill updates the index by validating relative paths and integrating the new content automatically.