actions
/
mdBook
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
mdBook/book-example/src
History
Phaiax 0ad8535084 Search: Add config documentation. Add to contributors. 2017-11-26 19:41:39 +01:00
..
cli updated links from azerupi to rust-lang-nursery (#489) 2017-11-22 11:35:18 +01:00
format Search: Add config documentation. Add to contributors. 2017-11-26 19:41:39 +01:00
lib Minor cleanup 2017-06-14 21:55:42 +02:00
misc Search: Add config documentation. Add to contributors. 2017-11-26 19:41:39 +01:00
README.md updated links from azerupi to rust-lang-nursery (#489) 2017-11-22 11:35:18 +01:00
SUMMARY.md Remove the empty introduction chapter 2017-08-02 15:04:03 +02: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