bmad-shard-doc

Split Markdown documents into level-2 section files with an index.

1|Updated Aug 3, 2025
One-click install
npx skills add https://github.com/MazenMrad/Obsidio --skill bmad-shard-doc-mazenmrad
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bmad-shard-doc
Source: https://github.com/MazenMrad/Obsidio/tree/main/.cursor/skills/bmad-shard-doc
Command: npx skills add https://github.com/MazenMrad/Obsidio --skill bmad-shard-doc-mazenmrad

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Large Markdown documents can become unwieldy and hard to navigate. Sharding them into smaller, section-based files improves readability, maintainability, and collaboration.

Core Features & Use Cases

  • Breaks a document into separate files for each level 2 section to simplify editing and navigation.
  • Generates an index.md to preserve section order and provide quick access to all shards.
  • Uses the markdown-tree-parser tool to explode the source document into a structured destination folder.

Quick Start

Run the shard operation on a source Markdown file to generate a folder containing individual files for each level-2 section.

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 organized files?

You can split large Markdown documents into smaller, organized files by extracting level-2 sections into individual files within a structured destination folder, generating an index.md for navigation.

What is the best way to break down long technical manuals into modular sections?

Breaking down long technical manuals is best achieved by sharding the source document into section-based files. This creates modular access to each level-2 section while preserving the original order in an index.

How does sharding a Markdown knowledge base improve content organization?

Sharding a Markdown knowledge base improves content organization by exploding a single unwieldy file into a structured destination folder. This simplifies editing, navigation, and collaboration across modular section files.

Can I generate a navigation index when splitting Markdown files?

Yes, generating a navigation index is part of the sharding process. When a source Markdown document is exploded into section files, an index.md is automatically generated to preserve section order and provide quick access.

Does this Markdown sharding process work without external dependencies?

The Markdown sharding process operates by using the markdown-tree-parser to explode the source document. It requires no additional external dependencies to break the content into a structured destination folder.

When should I not use level-2 section splitting for document management?

You should avoid level-2 section splitting for short Markdown documents or files lacking proper heading hierarchy, as the markdown-tree-parser needs level-2 sections to explode the source into a structured destination folder.