bmad-shard-doc

Split large Markdown documents into section-based shard files with an index.md.

Updated Apr 12, 2026
One-click install
npx skills add https://github.com/clovernguyen1010-ship-it/Clover_Nguyen --skill bmad-shard-doc-clovernguyen1010-ship-it
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bmad-shard-doc
Source: https://github.com/clovernguyen1010-ship-it/Clover_Nguyen/tree/main/_bmad/core/bmad-shard-doc
Command: npx skills add https://github.com/clovernguyen1010-ship-it/Clover_Nguyen --skill bmad-shard-doc-clovernguyen1010-ship-it

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Splitting large Markdown documents into smaller, navigable shard files by section boundaries to improve readability, maintenance, and collaboration.

Core Features & Use Cases

  • Fragmentation by level-2 sections to create a predictable file structure.
  • Automatically generate an index.md to summarize all shards and preserve navigability.
  • Use case: a long documentation file can be broken into per-section documents for easier review and versioning.

Quick Start

Place your source Markdown file and run the shard operation to generate a folder of sectioned files.

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 files?

Splitting large Markdown documents is done by using level-2 headings as boundaries to generate separate shard files. This process outputs an index.md file alongside per-section documents to improve readability, maintenance, and collaboration.

What is the best way to organize long Markdown documentation for section-based editing?

Organizing long Markdown documentation is best achieved by fragmenting the file by level-2 sections to create a predictable file structure. This approach automatically generates an index.md to summarize all shards and preserve navigability for easier review and versioning.

Does this Markdown sharding approach work with any heading level?

No, this Markdown sharding approach does not work with any heading level, as it specifically relies on a standard Markdown structure using level-2 headings as shard boundaries. Input validation ensures deterministic behavior based on this requirement.

Can I automatically generate an index file when breaking down a Markdown document?

Yes, you can automatically generate an index.md file when breaking down a Markdown document into shards. This index summarizes all the generated per-section files to preserve navigability across the fragmented documentation.

What are the limitations of sharding Markdown files by section boundaries?

The main limitation of sharding Markdown files by section boundaries is the strict reliance on level-2 headings to determine file splits, meaning documents without this standard structure cannot be processed. The behavior is deterministic but constrained to this specific heading level.