mdBook Plugin
Create modern online books from Markdown files.
Commands
Build
mdbook build run— Build a book from markdown filesmdbook serve run— Serve book with live reloadmdbook init run— Initialize a new book
Maintenance
mdbook clean run— Delete built bookmdbook test run— Test Rust code examples in book
Usage Examples
- "Build my documentation book"
- "Initialize a new book project"
- "Serve the book locally"
- "Clean the build output"
Installation
cargo install mdbook
Examples
# Create a new book
mdbook init my-book
# Build the book
mdbook build
# Serve with live reload
mdbook serve --open
# Clean
mdbook clean
Key Features
- Markdown-based documentation
- Live reload dev server
- Math equations (KaTeX)
- Code block theming
- Search functionality
- Multi-language support