History

A Ho 75d0f1efd4 Suggest dplyv2 changes to .travis.yml as a note This is following @ehuss' comment to not recommend something currently in beta release.		2020-11-13 09:40:33 +00:00
..
cli	Rename `book-example` to `guide` (#1336 )	2020-09-23 03:16:09 +02:00
for_developers	Rename `book-example` to `guide` (#1336 )	2020-09-23 03:16:09 +02:00
format	List supported Highlight.js languages in guide (#1345 )	2020-09-30 01:56:31 +02: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	Suggest dplyv2 changes to .travis.yml as a note	2020-11-13 09:40:33 +00: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.