md-book

Official

Generate HTML docs from Markdown with MD-Book.

Authorterraphim
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Software teams often struggle to convert Markdown documentation into polished, navigable HTML without handcrafting HTML templates.

MD-Book provides a Rust-based solution that converts Markdown files into fast, searchable HTML docs with syntax highlighting, live-reload, and template-driven layouts.

Core Features & Use Cases

  • Syntax Highlighting: Server-side code highlighting for multiple languages.
  • Live Reload & Serve: Development server with automatic reload for rapid iteration.
  • Pagefind Search: Integrated search indexing for quick navigation.
  • Template-driven UI: Tera templates for consistent look and feel across pages.
  • Use Case: Document Rust crates, APIs, and projects with up-to-date, branded documentation.

Quick Start

Install md-book locally and run:

  • Clone the repository: git clone https://github.com/terraphim/md-book.git
  • Build: cargo build --release
  • Run: ./target/release/md-book -i docs -o output --serve --watch

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: md-book
Download link: https://github.com/terraphim/terraphim-skills/archive/main.zip#md-book

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.