mdBook/book-example/src/README.md

17 lines
846 B
Markdown
Raw Normal View History

# mdBook
2015-09-25 04:19:14 +08:00
**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](http://www.rust-lang.org).
2015-09-25 04:19:14 +08:00
What you are reading serves as an example of the output of mdBook and at the same time as high-level docs.
2015-09-24 19:47:14 +08:00
mdBook is free and open source, you can find the source code on [Github](https://github.com/azerupi/mdBook). Issues and feature requests can be posted on the [Github Issue tracker](https://github.com/azerupi/mdBook/issues).
2015-08-06 21:24:34 +08:00
## API docs
Alongside this book you can also read the [API docs](mdbook/index.html) generated by Rustdoc if you would like
2015-09-25 04:19:14 +08:00
to use mdBook as a crate or write a new renderer and need a more low-level overview.
2015-08-06 21:24:34 +08:00
## License
2015-09-25 04:19:14 +08:00
mdBook, all the source code, is released under the [Mozilla Public License v2.0](https://www.mozilla.org/MPL/2.0/)