bmad-shard-doc

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

Updated Mar 18, 2026
One-click install
npx skills add https://github.com/AhmedKaram50/research --skill bmad-shard-doc-ahmedkaram50
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bmad-shard-doc
Source: https://github.com/AhmedKaram50/research/tree/main/shopify-builder/_bmad/core/skills/bmad-shard-doc
Command: npx skills add https://github.com/AhmedKaram50/research --skill bmad-shard-doc-ahmedkaram50

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Splits large Markdown documents into smaller, organized files by level-2 sections to improve navigation and maintainability.

Core Features & Use Cases

  • Divides content automatically by level-2 headings into a destination folder.
  • Generates an index.md to provide a consolidated entry point for the shards.
  • Useful for knowledge bases, design docs, and long-form specifications that must be browsed or versioned incrementally.

Quick Start

Shard a long markdown document into a folder of sectioned files with a single command.

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 separate files by section?

To split a large Markdown document, this Skill divides content automatically by level-2 headings into a destination folder and generates an index.md to provide a consolidated entry point for the shards.

Does sharding Markdown files require Node.js?

Yes, sharding Markdown files requires a Node.js-based workflow using npx @kayvan/markdown-tree-parser to explode the source document and produce the section-level files in the destination folder.

What is the best way to organize long-form technical guides for easier navigation?

The best way to organize long-form technical guides for navigation is sharding them into focused sub-files based on level-2 sections, which allows users to browse and version the documentation incrementally.

Can I use this Markdown organization approach for knowledge bases and design docs?

Yes, you can use this Markdown organization approach for knowledge bases, design docs, and long-form specifications that must be browsed or versioned incrementally by sharding them into section-based files.

How does the generated index.md work after sharding a Markdown document?

The generated index.md works as a consolidated entry point that links to the individual section-based shard files produced when the Markdown document is exploded by level-2 headings into the destination folder.