actions
/
mdBook
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
mdBook/book-example/src
History
Bulat Musin 6af77a7792 Update documentation to reflect addition of `clean` subcommand. (#607) 
* update documentation

Update README.md and User Guide to reflect addition of `clean`
subcommand. Do minor spelling fixes too.

* fix grammar in `clean` documentation
 		2018-02-18 15:04:04 +08:00
..
cli Update documentation to reflect addition of `clean` subcommand. (#607) 2018-02-18 15:04:04 +08:00
for_developers Updated Cargo.toml metadata to make releases easier (#584) 2018-01-26 01:11:32 +08:00
format Fix typo in format configuration 2018-02-05 13:01:17 +01:00
misc Documenting the editor #521 2018-01-16 21:26:13 -08:00
README.md updated links from azerupi to rust-lang-nursery (#489) 2017-11-22 11:35:18 +01:00
SUMMARY.md Update documentation to reflect addition of `clean` subcommand. (#607) 2018-02-18 15:04:04 +08: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