mdBook vs Weave.jl
mdBook
rust-lang.github.ioWeave.jl
weavejl.mpastell.comSide by side
| Figure | mdBook | Weave.jl |
|---|---|---|
| Price from | Free | — |
| Free plan | Yes | — |
| Free trial | — | — |
| Open source | — | — |
| Windows | Yes | — |
| macOS | Yes | — |
| Linux | Yes | — |
| Plans published | 1 | 0 |
| Spec score · Documentation Generators | 7.8 (#12) | 5.9 (#34) |
| Integrations | The documentation describes using GitHub Actions or GitLab CI/CD to test and deploy books automatically. | The documentation describes publishing through Julia or Pandoc and editor support in Juno and Visual Studio Code. |
| Purpose | mdBook is a command-line tool for creating books from Markdown, including product or API documentation, tutorials, and course materials. | Weave is a scientific report generator and literate programming tool for Julia. |
| 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. | The README invites users to contribute by opening GitHub issues or submitting pull requests. |
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.
Weave.jl
Weave.jl has no write-up on Specifiction yet; its figures are above.