bmad-index-docs

Generate an index.md with relative links and descriptions for documents in a folder.

Updated Apr 25, 2026

Search Tags:#automation #documentation #docs #directory #index #content-management

Ready to run

npx skills add https://github.com/ldk-hub/broke-shopping --skill bmad-index-docs-ldk-hub

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: bmad-index-docs
Source: https://github.com/ldk-hub/broke-shopping/tree/main/.claude/skills/bmad-index-docs
Command: npx skills add https://github.com/ldk-hub/broke-shopping --skill bmad-index-docs-ldk-hub

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill generates or updates an index.md that references all documents inside a target folder, saving time organizing large doc collections.

Core Features & Use Cases

Auto-discovers files and subfolders within the target directory.
Groups and describes content for quick navigation.
Generates a single index.md with relative links and concise descriptions.

Quick Start

Run the skill to generate or update an index.md that references all documents in a target 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 directory index for my project documentation?▼

To generate a directory index for project documentation, this skill recursively scans the target folder and creates a navigable index.md. It groups files by type and location, producing relative links and concise descriptions for streamlined documentation discovery.

What is the best way to organize a large collection of markdown docs and reference materials?▼

Organizing a large collection of markdown docs is simplified by generating a single index.md. This skill auto-discovers files and subfolders, applying alphabetical grouping and descriptive entries to ensure deterministic navigation across your knowledge base.

Can I use this to build a navigable index for nested subfolders in a knowledge base?▼

Yes, you can build a navigable index for nested subfolders in a knowledge base. The skill scans target directories recursively, grouping content by location and type to produce a coherent index with relative links for quick navigation.

How do I create relative links for all files in a documentation folder automatically?▼

Creating relative links for files in a documentation folder is handled automatically during index generation. The skill ensures all entries in the resulting index.md use relative links, enabling deterministic navigation without manual path configuration.

Does this content management skill update an existing index.md or only create a new one?▼

This content management skill generates or updates an existing index.md. When run on a target directory, it scans the contents and refreshes the index with current files, applying alphabetical grouping and descriptive entries to reflect the latest documentation state.