bmad-index-docs

Generate or update an index.md with relative links for all documents in a folder.

4|1|Updated Sep 30, 2024
One-click install
npx skills add https://github.com/co-cddo/ndx --skill bmad-index-docs-co-cddo
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bmad-index-docs
Source: https://github.com/co-cddo/ndx/tree/main/_bmad/core/bmad-index-docs
Command: npx skills add https://github.com/co-cddo/ndx --skill bmad-index-docs-co-cddo

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Creates or updates an index.md that references every document in a target folder, enabling quick file discovery and navigation.

Core Features & Use Cases

  • Scans a specified folder (and subfolders) to enumerate all files and directories.
  • Generates clean, human-readable entries with relative links.
  • Updates existing index.md or creates one when absent to reflect current contents.

Quick Start

Update the index.md for the target folder to reference all contained files and subfolders.

Frequently Asked Questions about bmad-index-docs

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

FAQPage Schema
How do I auto-generate an index.md for my folder documentation?

To auto-generate an index.md, the Skill recursively reads a target folder's contents, formats all files and subfolders as entries with relative links, and writes the resulting index.md directly into that directory.

What is the best way to create a markdown index for all files in a repository?

The best way to create a markdown index is to recursively enumerate all documents and subfolders in a target directory, format them as human-readable entries with relative links, and write them into an index.md file.

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

Yes, you can update an existing index.md by recursively re-scanning the target folder and overwriting the file with new entries that reference all currently contained documents and subfolders.

Does auto-indexing documentation work recursively for subfolders?

Yes, auto-indexing works recursively for subfolders, reading all nested directory contents to ensure every document and subfolder is listed and linked in the generated index.md file.

When do I need to generate an index file for my documentation folder?

You need to generate an index file when a repository has substantial documentation, requiring a central index.md to enable quick file discovery and navigation across all contained documents.