History

Mathieu David dc8f6cd5e9 Add contributors to the doc + set visisted links to the same color as normal links		2015-12-30 15:59:18 +01:00
..
cli	Update documentation, Closes #80	2015-12-30 15:04:24 +01:00
format	Update documentation, Closes #80	2015-12-30 15:04:24 +01:00
lib	fix mdbook test for the book	2015-12-29 17:59:08 -05:00
misc	Add contributors to the doc + set visisted links to the same color as normal links	2015-12-30 15:59:18 +01:00
README.md	update docs	2015-09-24 22:19:14 +02:00
SUMMARY.md	Update documentation, Closes #80	2015-12-30 15:04:24 +01: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