bmad-shard-doc

Split large Markdown documents into section-based files using markdown-tree-parser.

3|2|Updated Mar 29, 2024
One-click install
npx skills add https://github.com/josemariafs/MVTools --skill bmad-shard-doc-josemariafs
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: bmad-shard-doc
Source: https://github.com/josemariafs/MVTools/tree/main/.cursor/skills/bmad-shard-doc
Command: npx skills add https://github.com/josemariafs/MVTools --skill bmad-shard-doc-josemariafs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Split large Markdown documents into smaller, organized files based on level-2 sections using the markdown-tree-parser.

Core Features & Use Cases

  • Shards long documents into modular, section-based files for easier navigation and versioning.
  • Automatically generates an index.md to document the shard structure for quick reference.
  • Use Case: Large product docs or internal specifications can be broken into manageable chunks without losing context.

Quick Start

Provide the source Markdown document and run the shard tool to generate a folder of sectioned 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?▼

Splitting large Markdown documents involves breaking them into smaller, organized files based on level-2 sections using the markdown-tree-parser. This process creates modular, section-based files for easier navigation and versioning.

What is Markdown sharding for software documentation?▼

Markdown sharding is the process of breaking large documents into modular, section-based files. It automatically generates an index.md to document the shard structure, allowing large product docs or internal specifications to be managed without losing context.

How do I shard a Markdown file by level-2 sections?▼

To shard a Markdown file, provide the source document and run the shard tool to generate a folder of sectioned files. The process validates the source, creates the destination, executes the command, verifies the output, and reports completion.

Does the Markdown shard workflow generate an index file?▼

Yes, the Markdown shard workflow automatically generates an index.md file to document the shard structure. This index provides a quick reference for navigating the newly created modular, section-based files.

Can I use Markdown sharding for large project specifications?▼

Yes, you can use Markdown sharding for large project specifications. It breaks long internal specifications into manageable, modular chunks based on level-2 sections, making them easier to navigate and version without losing context.

What are the limitations of sharding Markdown by level-2 sections?▼

The primary limitation is that sharding relies strictly on level-2 sections to split the Markdown document. Content not organized under level-2 headings will not be separated into individual modular files, potentially affecting the final structure.