bmad-index-docs

To automatically generate a markdown index for your docs folder, use this tool to scan the target directory and produce a readable index.md with relative links to all files and subfolders.

Keeping documentation indexes updated as files change is done by re-running the directory scan to regenerate or update the existing index.md, ensuring quick navigation and up-to-date references for all current items.

Yes, you can group documentation files by type when generating a directory index. The tool reads the target folder, groups content by type and location, and writes these categorized sections into the index.md.

Yes, the generated index.md uses relative paths for file navigation. This ensures that the links to your documentation files and subfolders remain valid regardless of the root folder's location.

Organizing markdown files for quick reference in a project is best achieved by generating an index.md at the root, grouping items by type, and providing relative links to enable immediate navigation.

Updating an existing index.md scans the directory and writes or updates the file in the root to reflect current changes. To preserve manual edits, maintain them outside the generated index structure.