mdBook
A command-line tool that builds online books from a folder of Markdown files.
These buttons open the developer's own site, repository or store listing in a new tab. wares.gg does not host downloads.
About mdBook
mdBook turns a set of Markdown files into a browsable online book. The result is a static HTML site with a sidebar table of contents and chapter navigation. It is written in Rust and maintained under the rust-lang organisation. It is used for Rust's own documentation and works for any technical book, guide or manual.
Because the output is a static site, the book can be hosted anywhere static files are served. It is similar in purpose to GitBook, but runs locally as a single command-line tool.
Strengths
- Builds a complete static site from plain Markdown
- Maintained by the Rust project with an active history
- Single fast binary
Limitations
- Command line only
- Aimed at web output rather than EPUB or print
Details
- Pricing
- FreeFree and open source.
- License
- MPL-2.0
- Developer
- The Rust project
- Platforms
- Windows, macOS, Linux, Command line
- How it runs
- Downloadable app
- Account
- Not required
- Works offline
- Yes
- Best suited for
- Writing technical documentation or books in Markdown and publishing them as a static site
- Categories
- Ebook tools, Developer tools
- Last verified
- Added
- Provenance
- Facts checked against the developer's own pages and store listings, 1 sources on file.
Alternatives to mdBook
Compare allSoftware that can replace mdBook for an important use case, and what changes if you switch.
MkDocs
Static site generator that builds documentation sites from Markdown.
MkDocs builds documentation sites from Markdown with a single YAML file and a live-reload server, relying on themes and plugins for search and versioning.
Docusaurus
React-based static site generator built for documentation sites.
Docusaurus is a React-based generator with built-in versioning, translation and MDX components, but it needs a Node toolchain and some React knowledge.
Hugo
A static site generator written in Go that builds thousands of pages in seconds from Markdown files.
Hugo is a single Go binary that builds large sites quickly with multilingual support, but its Go templates are harder to learn than mdBook's book layout.
mdBook as an alternative
Listings that name mdBook as an alternative.
Pressbooks
A web-based platform for writing and publishing digital books and open educational resources.
mdBook is a free, MPL-2.0 command-line tool that builds online books from Markdown as static sites, aimed at web output rather than EPUB or print.
Similar software
Related functionality, not necessarily a direct replacement.
Slidev
An open-source presentation tool that builds slide decks from Markdown, aimed at developers.
Emanote
A tool that turns a folder of Markdown notes into a linked, browsable website.
Mermaid
Generates diagrams from Markdown-like text.
PlantUML
Generates UML and architecture diagrams from text descriptions.
readme.so
Drag-and-drop editor for assembling a project README.
DevDocs
Searchable, offline-capable browser for hundreds of API documentation sets.
