History

cetra3 bdb37ec117 Use relative links and translate internal references (#603 ) * Relative links for 0.1.8 * Compat for IE11 search		2018-07-11 21:33:44 +08:00
..
cli	Use relative links and translate internal references (#603 )	2018-07-11 21:33:44 +08:00
for_developers	Use relative links and translate internal references (#603 )	2018-07-11 21:33:44 +08:00
format	Update documentation for preprocessor (#686 )	2018-05-06 23:48:11 +08:00
misc	Add index preprocessor (#685 )	2018-05-04 19:41:28 +08:00
README.md	updated links from azerupi to rust-lang-nursery (#489 )	2017-11-22 11:35:18 +01:00
SUMMARY.md	user guide: Add instructions for running `mdbook` in CI	2018-06-22 10:31:49 -07:00
continuous-integration.md	user guide: Add instructions for running `mdbook` in CI	2018-06-22 10:31:49 -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