History

Michael Bryan c777913136 Updated the configuration chapter in the book-example		2017-11-12 21:37:38 +08:00
..
cli	Remove blank *note* section	2017-01-17 00:19:09 +00:00
format	Updated the configuration chapter in the book-example	2017-11-12 21:37:38 +08:00
lib	Minor cleanup	2017-06-14 21:55:42 +02:00
misc	Added myself to the contributors list	2017-10-04 20:04:26 +08:00
README.md	Improve wording of documentation	2017-08-11 13:55:11 +02:00
SUMMARY.md	Remove the empty introduction chapter	2017-08-02 15:04:03 +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