bmad-shard-doc

Split large markdown documents into sections by level 2 headings.

15|2|Updated Apr 15, 2026
One-click install
npx skills add https://github.com/lorenzogm/bmad-ui --skill bmad-shard-doc-lorenzogm
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bmad-shard-doc
Source: https://github.com/lorenzogm/bmad-ui/tree/main/.cursor/skills/bmad-shard-doc
Command: npx skills add https://github.com/lorenzogm/bmad-ui --skill bmad-shard-doc-lorenzogm

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires @kayvan/markdown-tree-parser, and includes scripts (resource) components.

What problem does it solve?

This Skill addresses the issue of managing large markdown documents by splitting them into smaller, organized files, making it easier to navigate and maintain.

Core Features & Use Cases

  • Document Sharding: Automatically divides large markdown documents into smaller sections based on level 2 headings.
  • User Customization: Allows users to specify the destination folder and decide what to do with the original document after sharding.
  • Use Case: Ideal for developers or content creators who need to organize documentation or technical guides into more manageable pieces.

Quick Start

Perform shard document on the document at '/path/to/large-document.md' and store the sections in '/path/to/destination-folder/'.

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 sections?

To split a large markdown document into smaller sections, this Skill automates the process by dividing the file based on level 2 headings. It allows you to specify a destination folder and manage the original document after splitting.

What is document sharding for markdown files?

Document sharding for markdown files is the process of breaking down large documents into smaller, organized files. This makes technical documentation and content guides easier to navigate and maintain over time.

Do I need npx to split markdown files by headings?

Yes, you need npx and the @kayvan/markdown-tree-parser package to execute the markdown sharding process. These dependencies are required to parse the document structure and automate the file splitting.

Can I choose the destination folder when dividing a markdown document?

Yes, you can choose the destination folder when dividing a markdown document. The process supports user input for the destination path and allows you to decide what to do with the original document after sharding.

What is the best way to organize large technical documentation in markdown?

The best way to organize large technical documentation in markdown is to shard the file into smaller sections using level 2 headings. This creates manageable files that are easier to navigate and maintain for developers.

Why does markdown sharding only use level 2 headings?

Markdown sharding uses level 2 headings to ensure consistent document structure and logical content division. This approach automatically creates organized sections based on the main topics defined by the document's second-level headers.