History

Eric Huss b899c48019 Merge pull request #1566 from joshrotenberg/markdown_list_clarification Documentation clarification on markdown list markers		2021-06-07 15:30:21 -07:00
..
cli	Mention missing file creation in build/watch/serve's docs (#1548 )	2021-05-25 13:45:30 +02:00
for_developers	Reword incomplete sentence in Preprocessors section in the guide (#1510 )	2021-04-26 01:18:57 +02:00
format	Merge pull request #1566 from joshrotenberg/markdown_list_clarification	2021-06-07 15:30:21 -07:00
misc	Add entry to contributor section	2021-05-05 08:42:43 -04: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	restructure guide configuration section	2021-05-25 07:43:36 -07:00
continuous-integration.md	Change in gitlab CI (#1507 )	2021-04-23 11:51:42 +02: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.