History

Josh 5e998788e9 Fix typo in init.md "where" was spelled "were"		2019-12-31 15:36:12 -08:00
..
cli	Fix typo in init.md	2019-12-31 15:36:12 -08:00
for_developers	rust-lang-nursery -> rust-lang	2019-10-29 08:04:16 -05:00
format	Revert "Add support for Rust edition 2018 in playpens (#1086 )" (#1093 )	2019-11-11 13:24:13 +01:00
misc	Rewrap guide markdown at 80 columns	2018-08-02 21:34:26 -05:00
README.md	rust-lang-nursery -> rust-lang	2019-10-29 08:04:16 -05:00
SUMMARY.md	Issue 703 (#929 )	2019-05-19 22:16:10 +02:00
continuous-integration.md	Release 0.3.0	2019-06-18 15:24:26 -07:00

README.md

mdBook

mdBook is a command line tool and Rust crate to create books using Markdown files. It's very similar to Gitbook but written in Rust.

What you are reading serves as an example of the output of mdBook and at the same time as a high-level documentation.

mdBook is free and open source, you can find the source code on GitHub. Issues and feature requests can be posted on the GitHub issue tracker.

API docs

Alongside this book you can also read the API docs generated by Rustdoc if you would like to use mdBook as a crate or write a new renderer and need a more low-level overview.

License

mdBook, all the source code, is released under the Mozilla Public License v2.0.