History

Matt Ickstadt 34356b87a0 Document dest-dir relative path behavior		2018-09-06 10:24:42 -05:00
..
cli	Document dest-dir relative path behavior	2018-09-06 10:24:42 -05:00
for_developers	Rewrap guide markdown at 80 columns	2018-08-02 21:34:26 -05:00
format	Fix a typo	2018-08-20 23:48:18 -04:00
misc	Rewrap guide markdown at 80 columns	2018-08-02 21:34:26 -05:00
README.md	Rewrap guide markdown at 80 columns	2018-08-02 21:34:26 -05:00
SUMMARY.md	user guide: Add instructions for running `mdbook` in CI	2018-06-22 10:31:49 -07:00
continuous-integration.md	Rewrap guide markdown at 80 columns	2018-08-02 21:34:26 -05: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.