bmad-shard-doc

Split large Markdown documents into smaller files by level 2 sections.

Updated Nov 6, 2025
One-click install
npx skills add https://github.com/skyoxu/godotgame --skill bmad-shard-doc-skyoxu
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bmad-shard-doc
Source: https://github.com/skyoxu/godotgame/tree/main/.agents/skills/bmad-shard-doc
Command: npx skills add https://github.com/skyoxu/godotgame --skill bmad-shard-doc-skyoxu

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Splits large Markdown documents into smaller, organized files based on level 2 sections using npx @kayvan/markdown-tree-parser.

Core Features & Use Cases

  • Automates fragmentation of long Markdown files into section-based files for easier navigation and reuse.
  • Maintains an index.md shard to reconstruct the original document from the generated pieces.
  • Manages user-driven destination placement and validates write permissions, with an option to handle the original document post-sharding.

Quick Start

Provide the path to a Markdown document and run the shard operation to generate the shard directory structure.

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?

To split a large Markdown document, this Skill automates fragmentation into section-based files using level 2 sections. It processes long-form documentation and generates an organized directory structure to improve navigability and content reuse.

What is Markdown sharding and when do I need it?

Markdown sharding is the process of splitting large documents into smaller, organized files. You need it for long-form documentation or knowledge bases to improve navigability, enabling easier maintenance and content reuse across markdown-driven libraries.

Can I reconstruct the original document after sharding Markdown files?

Yes, you can reconstruct the original document after sharding. The Skill maintains an index.md shard that serves as a central index, allowing you to piece the generated section-based files back together into the original structure.

How do I manage destination paths when splitting Markdown files?

To manage destination paths when splitting Markdown files, the Skill validates write permissions and manages user-driven destination placement. It determines the destination directory, executes the sharding operation, and verifies the output structure.

Does this Markdown file splitter require any dependencies to run?

The Markdown file splitter requires npx @kayvan/markdown-tree-parser to run. It uses this parser to analyze the document tree and split the content based on level 2 sections without requiring additional manual setup.