mdBook

CI Status crates.io LICENSE

mdBook is a utility to create modern online books from Markdown files.

Check out the User Guide for a list of features and installation and usage information. The User Guide also serves as a demonstration to showcase what a book looks like.

If you are interested in contributing to the development of mdBook, check out the Contribution Guide.

License

All the code in this repository is released under the Mozilla Public License v2.0, for more information take a look at the LICENSE file.


Summary

GitBook-as-single-binary from rust-lang (22.2k stars, Rust): SUMMARY.md TOC -> book, no plugin system, minimal JS. Ideal for repo-docs-as-book.

Learnings

  • No-plugin-system is the philosophy (same as zola (OSS)): tiny config surface, boring upgrades. The Rust lane’s answer to docs; pairs naturally with the four-folder context system as a compiled book per repo.

Gotchas

  • (none yet)

Hands-on

(open: compile one repo’s context folders into a book)