bmad-index-docs

Generates or updates an index.md for all documents in a folder.

1|Updated Aug 3, 2025
One-click install
npx skills add https://github.com/MazenMrad/Obsidio --skill bmad-index-docs-mazenmrad
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bmad-index-docs
Source: https://github.com/MazenMrad/Obsidio/tree/main/.cursor/skills/bmad-index-docs
Command: npx skills add https://github.com/MazenMrad/Obsidio --skill bmad-index-docs-mazenmrad

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill eliminates the manual effort of tracking every file in a folder by generating or updating a centralized index that references all documents.

Core Features & Use Cases

  • Automatically scans a target directory to discover files and subfolders.
  • Groups and organizes items by type or subfolder to create a clear index.
  • Reads file contents to generate concise, informative descriptions for each entry.

Quick Start

Scan the target folder and generate or update an index.md that references every document within it.

Frequently Asked Questions about bmad-index-docs

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

FAQPage Schema
How do I generate a folder index for markdown documents?

To generate a folder index, the skill scans your specified directory, groups files and subfolders, reads their contents, and outputs a ready-to-use index.md that references all documents with concise descriptions.

What is the best way to create a navigable reference for project documentation?

Creating a navigable reference is best handled by automatically scanning the target directory to discover files, grouping items by subfolder or type, and generating an index.md with informative descriptions for onboarding new contributors.

Can I update an existing index.md to include new files in a folder?

Yes, you can update an existing index.md by scanning the target folder again to discover new files and subfolders, regenerating concise descriptions, and rewriting the centralized index to reference every current document.

How does the skill generate descriptions for each entry in the index?

The skill generates descriptions by reading the actual contents of each file discovered in the target directory, then writing concise, informative summaries for every entry grouped within the output index.md.

Do I need any dependencies to automatically scan a folder and generate documentation?

No dependencies are required to scan a folder and generate documentation, as the skill operates independently to read directory contents, group items, and write a centralized index.md referencing all project documents.