docs-mdbook-preprocessor-dev

Develop Rust mdbook preprocessor plugins with TDD and documentation.

7|3|Updated Nov 15, 2025
One-click install
npx skills add https://github.com/aRustyDev/ai --skill docs-mdbook-preprocessor-dev
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-mdbook-preprocessor-dev
Source: https://github.com/aRustyDev/ai/tree/main/components/skills/docs-mdbook-preprocessor-dev
Command: npx skills add https://github.com/aRustyDev/ai --skill docs-mdbook-preprocessor-dev

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill guides developing custom MDBook preprocessor plugins in Rust, including planning, skeleton project setup, TDD workflow, and documentation.

Core Features & Use Cases

  • Planning plugin functionality with the user
  • Skeleton project setup and templating for mdbook preprocessors
  • Test-driven development workflow and ADR documentation

Quick Start

Create a new mdbook preprocessor project in Rust, implement a basic processor, wire it into book.toml, and run tests.

Frequently Asked Questions about docs-mdbook-preprocessor-dev

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I develop an mdbook preprocessor in Rust?

Develop an mdbook preprocessor by creating a Rust project using the mdbook-preprocessor interface, implementing input/output schema handling, and integrating it into book.toml. The Skill covers skeleton setup, TDD workflow, and complete plugin implementation from planning through repository creation.

What's the best way to transform mdbook content during builds?

Use an mdbook preprocessor plugin to intercept and modify book content at build time. This Skill guides you through planning plugin functionality, writing tests, documenting data flows and schemas, and implementing the Rust processor using mdbook's preprocessing interface.

Do I need to know Rust to create an mdbook plugin?

Yes, this Skill assumes Rust knowledge and teaches mdbook-preprocessor development using Rust and the mdbook crate. It covers test-driven development, Cargo.toml configuration, and the mdbook-preprocessor interface, progressing from planning through implementation.

How do I set up a test-driven workflow for mdbook preprocessors?

Build test scaffolding alongside your preprocessor implementation, following TDD practices to validate input/output transformations. This Skill includes guidance on writing tests, documenting behavior with ADRs and data-flow diagrams, and validating schema compliance before deployment.

What documentation should an mdbook preprocessor include?

Preprocessors require Architecture Decision Records (ADRs), data-flow diagrams, input/output schemas, examples, and user stories. This Skill covers documenting plugin functionality, dependencies, and integration points so users understand what the preprocessor transforms and why.

Can I find existing mdbook plugins to learn from?

Yes, this Skill includes discovery of existing mdbook plugins as a learning step. You'll explore community preprocessors to understand patterns, then build your own custom plugin with GitHub repository scaffolding under your account.