bmad-shard-doc

Name: bmad-shard-doc
Availability: InStock
Author: GenEd

Splits large markdown documents into smaller section files by level 2 headings.

Updated Mar 30, 2026

Search Tags:#markdown #file management #sharding #document splitting #section organization #level 2 headings

Ready to run

npx skills add https://github.com/GenEducation/GenedUIProject --skill bmad-shard-doc-geneducation

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: bmad-shard-doc
Source: https://github.com/GenEducation/GenedUIProject/tree/main/.gemini/skills/bmad-shard-doc
Command: npx skills add https://github.com/GenEducation/GenedUIProject --skill bmad-shard-doc-geneducation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill turns oversized markdown documents into smaller, easier-to-manage files so long reports, manuals, and notes become simpler to navigate and maintain.

Core Features & Use Cases

Section-Based Sharding: Breaks a source markdown file into organized pieces using level 2 headings by default.
Workflow Validation: Checks the source path, confirms the destination, verifies output files, and ensures an index file is created.
Original File Handling: Guides the user through deleting, archiving, or keeping the original document after sharding.
Use Case: Use it when a policy doc, handbook, or planning brief has grown too large and needs to be split into smaller linked sections for easier editing.

Quick Start

Ask the skill to shard the markdown file at your source path into a destination folder organized by sections.

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 section files?▼

You can split a large markdown document into smaller organized files using level 2 headings as breakpoints. This process validates the source path, creates a destination folder, generates section files, and verifies an index file is produced.

What is the best way to organize long markdown manuals for easier editing?▼

The best way to organize long markdown manuals is section-based sharding, which breaks the source file into linked pieces by level 2 headings. This workflow ensures easier navigation and verifies output files before guiding you on archiving the original.

Does splitting markdown files by level 2 headings work for long-form notes and policy docs?▼

Yes, splitting markdown files by level 2 headings works for long-form notes, policy docs, and planning briefs. It validates the source path, confirms the destination folder, and breaks the document into manageable linked sections for easier maintenance.

Can I specify a destination folder when sharding a markdown file into sections?▼

Yes, you can specify a destination folder when sharding a markdown file. The workflow validates the source path, confirms the destination folder creation, splits the document by level 2 headings, and verifies the resulting output files.

What happens to the original markdown file after it is split into smaller sections?▼

After splitting a markdown file into smaller sections, the workflow guides you through handling the original file. You can choose to delete, archive, or keep the original document based on your file management preferences.

Do I need npx @kayvan/markdown-tree-parser to explode a markdown document into sections?▼

Yes, you need npx @kayvan/markdown-tree-parser to execute the explode workflow. This dependency splits the source markdown into organized section files, requires path validation, and verifies the generated index file.