Mirrors/mdBook
2
0
Fork 0
mirror of https://github.com/rust-lang/mdBook synced 2024-12-13 22:32:35 +00:00
Code Issues Projects Releases Packages Wiki Activity
mdBook/book-example/src
History
Mathieu David c6b6069ed3 Tweaks to the docs + clean-up
2015-08-06 15:24:34 +02:00
..
cli Tweaks to the docs + clean-up 2015-08-06 15:24:34 +02:00
format Tweaks to the docs + clean-up 2015-08-06 15:24:34 +02:00
lib Tweaks to the docs + clean-up 2015-08-06 15:24:34 +02:00
README.md Tweaks to the docs + clean-up 2015-08-06 15:24:34 +02:00
SUMMARY.md Add rustdoc generated API doc 2015-08-06 12:38:48 +02:00

README.md

mdBook

mdBook is a command line tool and Rust library to create books using Markdown. It's very similar to Gitbook but written in Rust.

This book serves as an example of the output of mdBook and as the docs at the same time.

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 parser.

License

mdBook, all the code and this book, are released under the Mozilla Public License v2.0