bmad-shard-doc

Split markdown documents into section files by level 2 headings.

Updated Apr 2, 2026
One-click install
npx skills add https://github.com/amitmishra-byldd/Bmad-Note-Maker --skill bmad-shard-doc-amitmishra-byldd
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bmad-shard-doc
Source: https://github.com/amitmishra-byldd/Bmad-Note-Maker/tree/main/_bmad/core/bmad-shard-doc
Command: npx skills add https://github.com/amitmishra-byldd/Bmad-Note-Maker --skill bmad-shard-doc-amitmishra-byldd

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Large markdown documents become hard to navigate, maintain, and reuse; this Skill automates splitting a single long document into smaller, organized files to simplify editing, versioning, and publication workflows.

Core Features & Use Cases

  • Splits markdown documents into separate files based on level 2 headings, producing a navigable folder of section files and an index.md.
  • Uses the npx @kayvan/markdown-tree-parser explode command to perform deterministic sharding while validating source, destination, and command output.
  • Includes post-processing options to delete, archive, or keep the original file with permission checks and clear user prompts to avoid accidental data loss.

Quick Start

Shard the markdown file /path/to/architecture.md into section files using the default destination folder when prompted.

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 file into separate section files automatically?

To split a large markdown file into smaller sections, this Skill runs npx @kayvan/markdown-tree-parser explode, dividing the document by level 2 headings and generating an index.md for organized navigation.

What is the best way to organize long markdown architecture notes for easier editing?

Sharding long markdown architecture notes into a navigable folder of section files simplifies editing, versioning, and publication workflows by breaking down long-form content into manageable, organized parts.

How does markdown sharding handle the original file after splitting?

After markdown sharding completes, the Skill offers post-processing options to delete, archive, or keep the original file, utilizing permission checks and clear user prompts to prevent accidental data loss.

Can I use npx markdown-tree-parser to shard markdown files without installing dependencies?

Yes, you can use npx @kayvan/markdown-tree-parser explode to shard markdown files without permanent installation, as the Skill executes the command directly while verifying destination and index.md creation.

Does markdown sharding work with documents that lack level 2 headings?

Markdown sharding relies on level 2 headings to delineate sections, so documents lacking these headings will not be split into organized section files or generate a navigable index.md.