History

Mathieu David 23efa9e146 Document the TOML configuration file		2017-06-04 20:41:31 +02:00
..
cli	Remove blank *note* section	2017-01-17 00:19:09 +00:00
format	Document the TOML configuration file	2017-06-04 20:41:31 +02:00
lib	Fix broken link in book-example/src/lib/lib.md	2017-05-01 20:32:06 -04:00
misc	update example to encourage using book.toml	2016-12-23 08:17:04 +00:00
README.md	update docs	2015-09-24 22:19:14 +02:00
SUMMARY.md	update example to encourage using book.toml	2016-12-23 08:17:04 +00: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 high-level docs.

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