mdBook

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 builds static files into a book directory that can be transferred to a web service. Integrated search and syntax highlighting for code blocks help readers navigate and interpret the content, while theme files let authors customize output formatting. Preprocessors can add custom syntax or alter content, and backends can render output to multiple formats. The mdbook test command checks Rust code samples in a book. Documentation describes workflows using GitHub Actions or GitLab CI/CD to test and deploy books. Developers can also import mdBook libraries or use its plugin mechanism to create custom tools and output backends. The listed platforms are Linux, macOS, and Windows. Building from source requires Rust and Cargo, with Rust 1.88 as the stated minimum. The project directs issues and feature requests to its GitHub issue tracker and relies on community contributions for improvements.