bmad-shard-doc

Split markdown documents into section-based files and generate an index.

1|Updated Dec 22, 2022
One-click install
npx skills add https://github.com/Rinzler78/osmosis-launcher --skill bmad-shard-doc-rinzler78
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bmad-shard-doc
Source: https://github.com/Rinzler78/osmosis-launcher/tree/main/.agents/skills/bmad-shard-doc
Command: npx skills add https://github.com/Rinzler78/osmosis-launcher --skill bmad-shard-doc-rinzler78

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires npx.

What problem does it solve?

This Skill removes the manual effort of breaking a large markdown document into smaller, manageable files while preserving structure and navigability.

Core Features & Use Cases

  • Section-based splitting: Divides a markdown file into smaller files using level 2 headings by default.
  • Index generation: Creates an index.md file to keep the shard set organized and easy to browse.
  • Original-file handling: Guides the user to delete, archive, or keep the source document after sharding, with clear warnings about duplication risks.
  • Use case: A long architecture or policy document can be split into reusable sections for easier editing, review, and maintenance.

Quick Start

Use the shard document skill to split this markdown file into section-based files and create an index in a new 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 files?

Splitting a markdown document into smaller files uses level 2 headings by default to create section-based shards. An index.md file is automatically generated to organize and navigate the resulting shard set.

What is markdown sharding for documentation workflows?

Markdown sharding decomposes a large document into reusable modular content sections. This process removes manual effort while preserving structure, enabling easier editing, review, and maintenance for documentation workflows.

Do I need npx to split markdown files into sections?

Yes, you need npx installed to run the required @kayvan/markdown-tree-parser dependency. The Skill validates source, destination, and output files before executing the section splitting and index generation.

What happens to the original markdown file after sharding?

After sharding, the Skill guides you to delete, archive, or keep the original document. Clear warnings about duplication risks are provided to help you manage the source file safely.

Can I split markdown files by headings other than level 2?

By default, the Skill splits markdown files using level 2 headings as the section boundaries. The metadata specifies this default behavior for creating the modular file structure.

What's the best way to organize split markdown documentation?

The best way to organize split markdown documentation is generating an index.md file alongside the section shards. This creates a browsable structure for modular content decomposition and easier navigation.