bmad-shard-doc

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

4|1|Updated Sep 30, 2024
One-click install
npx skills add https://github.com/co-cddo/ndx --skill bmad-shard-doc-co-cddo
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bmad-shard-doc
Source: https://github.com/co-cddo/ndx/tree/main/_bmad/core/bmad-shard-doc
Command: npx skills add https://github.com/co-cddo/ndx --skill bmad-shard-doc-co-cddo

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Splits large Markdown documents into smaller, organized files by breaking content at level 2 sections (default), enabling simpler navigation and reuse.

Core Features & Use Cases

  • Partition large docs into modular shards based on level-2 section boundaries (default).
  • Generate an index.md in the destination folder to summarize the shards and provide entry points for navigation.
  • Suitable for knowledge bases, long-form documentation, changelogs, and manuals where modular sections improve maintainability and collaboration.

Quick Start

Provide the source markdown file path and I will shard it into a destination folder using npx @kayvan/markdown-tree-parser, creating an index.md and section files.

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

To split a large markdown document, this Skill partitions content at level-2 section boundaries and writes modular shard files into a destination folder using the markdown-tree-parser package.

What is the best way to partition long-form markdown documentation for easier navigation?

Partitioning long-form markdown documentation involves breaking content into organized shards and generating an index.md file, which provides summary entry points for simpler navigation and reuse.

Can I use npx markdown-tree-parser to generate an index for my modular markdown shards?

Yes, you can use npx @kayvan/markdown-tree-parser to process a source markdown path, which automatically generates section files and an index.md to summarize the modular markdown shards.

Does this markdown partitioning approach work for breaking content at level 2 sections?

Yes, this markdown partitioning approach specifically breaks content at default level-2 section boundaries, making it suitable for knowledge bases, manuals, and changelogs requiring consistent sectioning.

What do I need to provide to start sharding a markdown file into a destination folder?

You need to provide the source markdown file path, and the Skill will shard it into a destination folder, creating section files and an index.md using npx markdown-tree-parser.

Are there limitations when using level-2 section partitioning for markdown content management?

Level-2 section partitioning is limited to breaking content at H2 boundaries by default, meaning documents lacking consistent level-2 headers may not shard into cleanly organized modular files.