bmad-shard-doc

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

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill addresses the challenge of managing and organizing excessively large Markdown documents by breaking them down into smaller, more manageable files based on their structure.

Core Features & Use Cases

  • Automated Document Splitting: Divides a single large Markdown file into multiple smaller files, each representing a distinct section (typically defined by H2 headings).
  • Organized Output: Creates a new directory structure to house the sharded files, including an index.md for easy navigation.
  • Use Case: If you have a lengthy technical specification document that is difficult to navigate or update, this Skill can shard it into individual component documents, making it easier for teams to collaborate and reference specific sections.

Quick Start

Use the bmad-shard-doc skill to split the document located at /path/to/large-document.md.

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 segmenting extensive documentation into smaller, organized files based on level 2 sections. It creates a hierarchical directory structure to house the sharded files for improved manageability.

What is the best way to organize lengthy technical specifications for team collaboration?

Organizing lengthy technical specifications is best achieved by sharding the large markdown file into individual component documents. This process creates an index.md for easy navigation, making it easier for teams to collaborate and reference specific sections.

Does the document splitting process require any specific markdown parsing tools?

The document splitting process requires the markdown-tree-parser tool to function. It uses this dependency to parse and explode markdown content into the hierarchical directory structure needed for organizing the sharded files.

How does sharding a markdown file based on headings work?

Sharding a markdown file works by dividing a single large document into multiple smaller files, each representing a distinct section typically defined by H2 headings. This automated segmentation ensures extensive documentation is broken down systematically.

Can I use this to break down an excessively large markdown file for easier navigation?

Yes, you can use this to break down an excessively large markdown file to address navigation challenges. It shards the document into a new directory structure of smaller, manageable files, including an index.md to facilitate easy navigation.