mdBook vs Widdershins
mdBook
rust-lang.github.ioWiddershins
github.comSide by side
| Figure | mdBook | Widdershins |
|---|---|---|
| Price from | Free | Free |
| Free plan | Yes | Yes |
| Free trial | — | — |
| Open source | — | — |
| Windows | Yes | — |
| macOS | Yes | — |
| Linux | Yes | Yes |
| API | — | Yes |
| Self-hosted | — | Yes |
| Plans published | 1 | 1 |
| Spec score · Documentation Generators | 7.8 (#12) | 7.1 (#28) |
| Code samples | The `mdbook test` command tests Rust code samples in a book. | It supports customizable code samples, including language tabs, and can use httpsnippet to generate samples. |
| Integrations | The documentation describes using GitHub Actions or GitLab CI/CD to test and deploy books automatically. | The README describes using Widdershins with Slate, ReSlate, Shins, and ReSpec renderers. |
| Purpose | mdBook is a command-line tool for creating books from Markdown, including product or API documentation, tutorials, and course materials. | Widdershins converts OpenAPI, Swagger, AsyncAPI, and Semoasa definitions into Markdown compatible with Slate and ReSlate. |
| Security | The repository links to a security policy. | The README documents generated Authorization headers in OpenAPI code samples and provides an option to customize the API key value. |
Plans
In their own words
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.
Widdershins
Widdershins has no write-up on Specifiction yet; its figures are above.