bmad-shard-doc

Splits Markdown documents into section-based files with index.md using level-2 headings.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Unwieldy, long Markdown documents are hard to navigate and maintain. This Skill splits them into smaller, section-based files to improve readability and collaboration.

Core Features & Use Cases

  • Splits a Markdown document into per-section files based on level-2 headings (default).
  • Creates an index and a structured folder for easy navigation and reuse.
  • Use Cases: technical docs, design notes, API references, project READMEs that require modularization.

Quick Start

Provide the source Markdown file path and let the tool generate a shard folder with per-section 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 long Markdown document into multiple section files?▼

Splitting a long Markdown document into section files requires providing the source file path to a markdown-tree-parser tool. It generates an output folder containing an index.md and individual files for each section to improve navigation and collaboration.

Do I need Node.js and npx to shard Markdown files into sections?▼

Yes, Node.js and npx are required to run the markdown-tree-parser tool for sharding Markdown files. These dependencies execute the script that reads your source document and generates the output folder with modular section files.

When should I modularize my Markdown documentation into separate files?▼

You should modularize Markdown documentation into separate files when managing large project docs, design notes, or API references. Splitting unwieldy documents into section-based files improves readability, navigation, and team collaboration across extensive knowledge bases.

How are Markdown sections organized after splitting a large document?▼

After splitting a Markdown document, sections are organized into a structured output folder. This folder contains an index.md file for easy navigation alongside individual files corresponding to each level-2 heading from the original source document.

Can I use this Markdown sharding approach for project READMEs and API references?▼

Yes, you can use this sharding approach for project READMEs and API references. It effectively breaks down large technical documentation and knowledge bases into modular, section-based files that enhance content reuse and team collaboration.