skills.rest
mschuerig
mschuerigCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

bmad-index-docs

Generate a sorted Markdown index with summaries for all files in a folder.

Updated Feb 11, 2026
Search Tags:#automation#markdown#indexing#organization#docs#folder-structure
One-click install
npx skills add https://github.com/mschuerig/peach-ios --skill bmad-index-docs-mschuerig
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: bmad-index-docs
Source: https://github.com/mschuerig/peach-ios/tree/main/_bmad/core/skills/bmad-index-docs
Command: npx skills add https://github.com/mschuerig/peach-ios --skill bmad-index-docs-mschuerig

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps teams quickly discover all documents within a folder by generating or updating a single index.md that lists files and brief descriptions.

Core Features & Use Cases

  • Generate or update an index.md that references every file in the target folder.
  • Read each file (where possible) to create concise, 3-10 word descriptions that aid navigation.
  • Keep the index in sync as new files are added or removed, ensuring accurate reflection of the folder contents.
  • Use case: you want to share a folder's contents with teammates without manually listing every file.

Quick Start

Run this skill against a target folder to generate 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 automatically generate a markdown index for all files in a folder?▼

To generate a markdown index for a folder, this skill reads the target directory, analyzes file contents, and writes a sorted index.md with concise 3-10 word descriptions for quick scanning and discoverability.

What is the best way to keep a folder structure index in sync as files change?▼

Keeping a folder structure index in sync is handled by running this skill against the target folder. It updates the existing index.md to accurately reflect newly added or removed files and their categories.

How do I create concise summaries of documents for quick navigation?▼

To create concise summaries for navigation, the skill reads each file where possible and automatically generates brief, 3-10 word descriptions that aid scanning within the generated markdown index.

Can I categorize and reference documents by type in an auto-generated index.md?▼

Yes, you can categorize and reference documents by type. The skill applies its indexing approach to any folder structure, sorting and grouping files to improve discoverability within the index.md file.

Does this folder indexing approach require any external dependencies?▼

No external dependencies are required. The folder indexing approach operates independently to read directory contents, analyze files, and write the sorted markdown index without needing additional components.

Related Skills

Explore More Content & Communication Skills→
MarkusonMarkuson

bmad-index-docs

Generate or update an index.md file with categorized file and subdirectory listings.

Community
Basic
pikkujspikkujs
56

pikku-websocket

Wire WebSocket channels to Pikku actions with per-action routing and EventHub pub/sub.

Official
Advanced
cosmicdreamscosmicdreams

obsidian-lint

Audit Obsidian vault filesystem layout and propose rule-based file moves.

Community
Intermediate
GenEducationGenEducation

bmad-index-docs

Generate or update index.md files with grouped relative links and file summaries.

Official
Basic