mdBook
A utility for creating modern online books from Markdown.
mdBook compiles a directory of Markdown chapters and a SUMMARY.md outline into a static, searchable HTML book with sidebar navigation, dark/light themes, and fenced code-block highlighting. It is intentionally similar to GitBook in function, but consumes plain Markdown without GitBook's proprietary configuration.
The project was originally written by Mathieu David and is now maintained by the Rust Programming Language Foundation. The official "Rust Programming Language" book, the Rust Reference, the Cargo Book, and many other Rust project guides are produced with it.
Outside the Rust ecosystem mdBook has spread to general documentation use; its build is fast (a fraction of a second for modest books), output requires no JavaScript build pipeline, and the search index works locally. Plugins (preprocessors and backends) extend it for diagrams, equations, embedded playgrounds, and PDF output.
Install
cargo install mdbook Or: Arch: sudo pacman -S mdbook macOS: brew install mdbook
Authors
- Rust Foundation
- mdBook contributors