skills.rest
Wizarck
WizarckCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

bmad-index-docs

Generates an index.md file cataloging all documents in a target folder.

2|Updated Apr 19, 2026
Search Tags:#documentation#markdown#docs#generate#directory#index#file catalog
One-click install
npx skills add https://github.com/Wizarck/nexandro --skill bmad-index-docs-wizarck
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: bmad-index-docs
Source: https://github.com/Wizarck/nexandro/tree/main/skills/bmad-index-docs
Command: npx skills add https://github.com/Wizarck/nexandro --skill bmad-index-docs-wizarck

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Documentation folders grow over time and become hard to navigate, forcing users to manually browse files to find what they need. This Skill automates the creation and maintenance of a structured index.md that catalogs every document with a meaningful description. ## Core Features & Use Cases - Directory Scanning: Lists all files and subdirectories in a target folder, skipping hidden files by default. - Content-Based Descriptions: Reads each file to generate accurate 3-10 word descriptions rather than guessing from filenames. - Organized Output: Groups files by type or subdirectory, sorts alphabetically, and writes relative-path links into index.md. - Use Case: After adding several architecture decision records to a docs folder, run this Skill to regenerate the index so every ADR is listed with a short summary and clickable link. ## Quick Start Ask the assistant to create or update an index of all files in your docs folder using this Skill.

Frequently Asked Questions about bmad-index-docs

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

FAQPage Schema
How do I create an index of all files in a folder?▼

Point the Skill at the target directory and it scans all files and subdirectories, reads each file's content, and writes an index.md with grouped, alphabetically sorted entries. Each entry includes a relative link and a short description.

How are file descriptions in the index generated?▼

Descriptions are generated by reading each file's actual content, not guessing from filenames. Each description is kept concise at 3-10 words so the index stays scannable.

Does the index include hidden files or subdirectories?▼

Hidden files starting with a dot are skipped by default unless explicitly specified. Subdirectories are included and rendered as their own sections with relative links to their files.

What happens if the target directory does not exist?▼

The Skill halts immediately if the target directory does not exist or is inaccessible. It also halts if the user lacks write permission to create or update index.md in that location.

Can I update an existing index.md instead of creating one?▼

Yes, the Skill supports both creating a new index.md and updating an existing one. It rescans the folder and refreshes entries so new or changed files are reflected in the output.

Related Skills

Explore More Software Engineering Skills→
ImaginerLabsImaginerLabs

bmad-index-docs

Generate an index.md cataloging documents in a target folder with descriptions.

Official
Intermediate
cabeznocabezno

bmb-skills-hub

Generate index, embedding, skill-tree, and MCP manifest files from a skills directory.

Community
Intermediate
y-miyazakiy-miyazaki
1

markdown-validation

Run markdownlint and markdown-link-check to validate Markdown files.

Community
Intermediate
yejuneyejune

{{persona::BRAND}}-docs-generation

Generate technical documentation from source code and OpenAPI specifications.

Community
Intermediate