History

Bas Bossink e3ec751a3f Issue 703 (#929 ) * Replace all occurances of altenate backend with alternative backed Rename test for consistency of the terminology. * Use better sed command		2019-05-19 22:16:10 +02:00
..
cli	Correct grammar: remove the redundancy	2019-04-12 22:53:21 +08:00
for_developers	Issue 703 (#929 )	2019-05-19 22:16:10 +02:00
format	Some documentation fixes. (#925 )	2019-05-19 00:05:57 +02:00
misc	Rewrap guide markdown at 80 columns	2018-08-02 21:34:26 -05:00
README.md	Rewrap guide markdown at 80 columns	2018-08-02 21:34:26 -05:00
SUMMARY.md	Issue 703 (#929 )	2019-05-19 22:16:10 +02:00
continuous-integration.md	Update mdbook 0.1 -> 0.2 in docs for CI (#918 )	2019-05-11 20:30:21 +02: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.