2015-07-30 17:59:08 +08:00
|
|
|
# mdBook
|
|
|
|
|
|
2018-08-03 10:34:26 +08:00
|
|
|
**mdBook** is a command line tool and Rust crate to create books using Markdown
|
2020-08-10 16:52:22 +08:00
|
|
|
(as by the [CommonMark](https://commonmark.org/) specification) files. It's very
|
|
|
|
|
similar to Gitbook but written in [Rust](http://www.rust-lang.org).
|
2015-07-30 17:59:08 +08:00
|
|
|
|
2018-08-03 10:34:26 +08:00
|
|
|
What you are reading serves as an example of the output of mdBook and at the
|
|
|
|
|
same time as a high-level documentation.
|
2015-07-30 17:59:08 +08:00
|
|
|
|
2018-08-03 10:34:26 +08:00
|
|
|
mdBook is free and open source, you can find the source code on
|
2019-10-29 21:04:16 +08:00
|
|
|
[GitHub](https://github.com/rust-lang/mdBook). Issues and feature
|
2018-08-03 10:34:26 +08:00
|
|
|
requests can be posted on the [GitHub issue
|
2019-10-29 21:04:16 +08:00
|
|
|
tracker](https://github.com/rust-lang/mdBook/issues).
|
2015-07-30 17:59:08 +08:00
|
|
|
|
2015-08-06 21:24:34 +08:00
|
|
|
## API docs
|
|
|
|
|
|
2018-08-03 10:34:26 +08:00
|
|
|
Alongside this book you can also read the [API
|
|
|
|
|
docs](https://docs.rs/mdbook/*/mdbook/) 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.
|
2015-08-06 21:24:34 +08:00
|
|
|
|
2015-07-30 17:59:08 +08:00
|
|
|
## License
|
|
|
|
|
|
2018-08-03 10:34:26 +08:00
|
|
|
mdBook, all the source code, is released under the [Mozilla Public License
|
|
|
|
|
v2.0](https://www.mozilla.org/MPL/2.0/).
|
