History

pauliyobo 1a2fa29209 introduced proposed suggestions related to the documentation		2021-09-04 23:44:27 +02:00
..
cli	Fix sentence on installation page.	2021-01-15 07:50:06 -08:00
for_developers	introduced proposed suggestions related to the documentation	2021-09-04 23:44:27 +02:00
format	docs: Use inline code for regex	2021-02-27 20:17:36 -08:00
misc	Add avisionh to contributors	2020-11-05 22:28:54 +00:00
404.md	Rename `book-example` to `guide` (#1336 )	2020-09-23 03:16:09 +02:00
README.md	Rename `book-example` to `guide` (#1336 )	2020-09-23 03:16:09 +02:00
SUMMARY.md	List supported Highlight.js languages in guide (#1345 )	2020-09-30 01:56:31 +02:00
continuous-integration.md	Remove --debug from GitLab CI	2020-12-04 09:12:00 -08: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.