bmad-shard-doc

Split Markdown documents into level-2 section files with an index.md.

Updated Mar 18, 2026
One-click install
npx skills add https://github.com/robotics-playground/skills --skill bmad-shard-doc-robotics-playground
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bmad-shard-doc
Source: https://github.com/robotics-playground/skills/tree/main/_bmad/core/skills/bmad-shard-doc
Command: npx skills add https://github.com/robotics-playground/skills --skill bmad-shard-doc-robotics-playground

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Splitting large Markdown documents into smaller, organized, reusable pieces to improve navigation and maintenance.

Core Features & Use Cases

  • Breaks content by level-2 sections into individual files.
  • Generates an index.md to provide an overview and entry point.
  • Useful for long design docs, READMEs, and specification sheets that need modularization and reuse.

Quick Start

Provide the path to the source Markdown document and I will shard it into a destination folder based on level-2 sections.

Frequently Asked Questions about bmad-shard-doc

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

FAQPage Schema
How do I split a large Markdown document into smaller organized files?

To split a large Markdown document, you provide the source file path and the document is sharded by level-2 sections into individual files within a destination folder. An index.md file is also generated to provide an overview and entry point.

What is the best way to modularize long-form documentation for easier navigation?

The best way to modularize long-form documentation is by sharding the Markdown source into level-2 sections. This process creates individual files for each section and an index.md overview, improving navigation and reuse.

Can I use the markdown-tree-parser to break down a README by level-2 sections?

Yes, you can break down a README by level-2 sections using the markdown-tree-parser. The workflow runs the parser's explode command on the source document to generate per-section files and an index.md in the destination folder.

Do I need to manually create an index file when sharding Markdown design notes?

No, you do not need to manually create an index file when sharding Markdown design notes. The workflow automatically generates an index.md in the destination folder to provide an overview and entry point for the modularized content.

Does sharding Markdown into separate files work for specification sheets?

Yes, sharding Markdown into separate files works for specification sheets. The workflow applies a deterministic process to split the document by level-2 sections, creating individual files and an index.md for easier navigation and reuse.