bmad-shard-doc

To split large Markdown documents into smaller organized sections, this skill shards files based on level-2 headings. It processes a .md source and generates a destination folder containing individual shard files and an index for navigation.

The best way to automate sharding long-form Markdown documentation is using the npx @kayvan/markdown-tree-parser explode command. This skill enforces a specific workflow to automatically split files by level-2 headings and generate an index.

Sharding a Markdown file by level-2 headings works by parsing the document structure and extracting each section into a separate file. It produces modular shard files organized by headings alongside an index.md to list and order them.

You do not need external dependencies installed locally to shard Markdown files into an index and organized sections. The skill relies on running npx @kayvan/markdown-tree-parser explode to process the source file directly.

This Markdown document sharding workflow is designed specifically for files with level-2 headings. If your source file lacks these headings, the tool cannot split it into modular organized sections or generate the corresponding index.

When breaking down a large Markdown file into shards, expect a destination folder containing individual section files. The output also includes an index.md file that lists and orders the generated shard files for easy navigation.