mdBook
rust-lang.github.io
- Free plan
- Windows
- macOS
- Linux
What mdBook is
mdBook is a free command-line tool for turning Markdown into books, including product or API documentation, tutorials, and course materials. It generates static output in a book directory that can be transferred to a web service. Integrated search and code syntax highlighting help readers navigate and read code examples, while theme files let authors adjust formatting. Preprocessors can add custom syntax or modify content, and backends can render books to multiple formats. The mdbook test command checks Rust code samples. Documentation describes GitHub Actions and GitLab CI/CD workflows for testing and deploying books. Developers can also import mdBook libraries or use its plugin mechanism to build tooling and output backends. It runs on Linux, macOS, and Windows. Building from source requires Rust and Cargo, and the stated minimum Rust version is 1.88. The project directs issues and feature requests to its GitHub issue tracker and relies on community contributions for bug fixes and new features.
Who it suits
mdBook suits developers and educators who want to publish Markdown-based documentation, tutorials, or course material. It is also relevant to teams looking to test and deploy books through CI/CD workflows.
Good to know, and what to watch
- Builds static book files for web hosting.
- Integrated search and code syntax highlighting are included.
- Themes, preprocessors, and backends allow customization.
- Can test Rust code samples.
- Documentation describes GitHub Actions and GitLab CI/CD use.
- It is a command-line tool.
- Building from source requires Rust and Cargo.
- Source builds require Rust 1.88 or later.
Plans
Every plan and pricemdBook
Free plan
The verdict
mdBook provides a free Markdown publishing workflow with search, code highlighting, and extension options. Its command-line approach and Rust source-build requirement are worth considering before choosing it.
What the maker publishes
- Audience
- The project describes mdBook as ideal for product or API documentation, tutorials, and course materials. source
- Code highlighting
- mdBook provides color syntax highlighting for code blocks in many languages. source
- Code samples
- The `mdbook test` command tests Rust code samples in a book. source
- Customization
- Theme files allow users to customize the formatting of the output. source
- Deployment
- mdBook builds static output files into a `book` directory that can be transferred to a web service. source
- Developer use
- Developers can import mdBook libraries directly or use its plugin mechanism to create custom tooling and output backends. source
- Extensions
- Preprocessors can extend custom syntax and modify content, while backends can render output to multiple formats. source
- Installation requirement
- Building from source requires Rust and Cargo, and mdBook currently requires at least Rust 1.88. source
- Integrations
- The documentation describes using GitHub Actions or GitLab CI/CD to test and deploy books automatically. source
- Platforms
- Precompiled executables are available for Windows, macOS, and Linux. source
- Purpose
- mdBook is a command-line tool for creating books from Markdown, including product or API documentation, tutorials, and course materials. source
- Search
- mdBook includes integrated search support. source
- Security
- The repository links to a security policy. source
- Support
- The project directs users to its GitHub issue tracker for issues and feature requests and relies on community contributions to fix bugs and add features. source
Checked against the maker's pages on 3 Oct 2026.