Asciidoctor vs mdBook
Asciidoctor
asciidoctor.orgmdBook
rust-lang.github.ioSide by side
| Figure | Asciidoctor | mdBook |
|---|---|---|
| Price from | Free | Free |
| Free plan | Yes | Yes |
| Free trial | — | — |
| Open source | — | — |
| Web | Yes | — |
| Windows | Yes | Yes |
| macOS | Yes | Yes |
| Linux | Yes | Yes |
| API | Yes | — |
| Self-hosted | Yes | — |
| Plans published | 1 | 1 |
| Spec score · Documentation Generators | 8.9 (#1) | 7.8 (#12) |
| Integrations | The project ecosystem includes Maven and Gradle plugins, browser extensions, an IntelliJ plugin, and tools such as Asciidoctor Diagram. | The documentation describes using GitHub Actions or GitLab CI/CD to test and deploy books automatically. |
| Purpose | Asciidoctor parses AsciiDoc source and converts it into publishable formats such as HTML 5 and PDF. | mdBook is a command-line tool for creating books from Markdown, including product or API documentation, tutorials, and course materials. |
| Support | The documentation directs users seeking real-time community support to the project chat’s #users stream. | 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. |
Plans
In their own words
Asciidoctor
Asciidoctor is a free, open-source text processor and publishing toolchain for converting AsciiDoc files or strings into formats such as HTML5, DocBook, PDF, EPUB 3 and manual pages. Its core includes converters for HTML5, DocBook 5 and man pages; PDF and EPUB 3 conversion comes from separate gems. Documents can be processed through a command-line interface or Ruby API. Asciidoctor runs with Ruby, on the JVM through AsciidoctorJ, or in JavaScript environments through Asciidoctor.js, and supports Linux, macOS and Windows. The wider ecosystem includes Maven and Gradle plugins, browser and editor extensions, and diagram tools. Default HTML output includes a stylesheet and integrations such as Font Awesome, highlight.js, Rouge, Pygments and MathJax. It is distributed as a RubyGem, Docker image, Linux packages and macOS packages, and is licensed under MIT. Its security modes include SECURE, SAFE, SERVER and UNSAFE; safe modes do not sanitize generated output or provide a comprehensive security framework.
mdBook
mdBook is a free command-line tool for creating books from Markdown, including product and API documentation, tutorials, and course materials. It builds static output files in a book directory that can be transferred to a web service. Integrated search and syntax highlighting for code blocks help readers navigate and read examples, while theme files allow formatting changes. Preprocessors can add custom syntax or modify content; backends can render output to multiple formats. The `mdbook test` command tests Rust code samples in a book. Project documentation describes using GitHub Actions or GitLab CI/CD to test and deploy books automatically. Developers can also import mdBook libraries or use its plugin mechanism to build custom tooling and output backends. It runs on Linux, macOS, and Windows, and Markdown is its source input. 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 bug fixes and added features. The free, open-source plan is licensed under MPL-2.0.