History

Fabien Tregan 2674347768 Adds information about markdown flavor in the documentation.		2020-08-10 10:52:22 +02:00
..
cli	Merge pull request #1164 from zdenek-crha/doc_gitignore_use	2020-04-21 10:21:34 -07:00
for_developers	Mention that uninstalled backend isn't marked optional.	2020-07-28 18:08:32 -03:00
format	Fix documentation for title and book_title	2020-07-16 16:43:46 +02:00
misc	Rewrap guide markdown at 80 columns	2018-08-02 21:34:26 -05:00
404.md	Generate 404.html page (#539 )	2020-06-10 12:46:23 +02:00
README.md	Adds information about markdown flavor in the documentation.	2020-08-10 10:52:22 +02:00
SUMMARY.md	Bring back draft chapters	2020-05-10 09:04:02 -07:00
continuous-integration.md	Release 0.3.0	2019-06-18 15:24:26 -07:00

README.md

mdBook

mdBook is a command line tool and Rust crate to create books using Markdown (as by the CommonMark specification) 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.