History

Mathieu David c5fa1854c3 update docs		2015-09-24 22:19:14 +02:00
..
cli	update docs	2015-09-24 22:19:14 +02:00
format	update docs	2015-09-24 22:19:14 +02:00
lib	Add documentation for MDBook #30	2015-08-06 21:10:59 +02:00
misc	Local fallback for jquery #46	2015-09-13 19:16:11 +02:00
README.md	update docs	2015-09-24 22:19:14 +02:00
SUMMARY.md	Big refactoring, now using enum for different book items (Chapter, Affix, Spacer, ...) Closes #9	2015-09-11 20:52:55 +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 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