9fe19d8f31
* Added documentation to the `config` module * Added an example to the `config` module * Updated the docs in lib.rs regarding implementing backends * Started writing an alternate backends walkthrough * Mentioned the output.foo.command key * Added example output * Added a config section to the backends tutorial * Finished off the backends tutorial * Made sure travis checks mdbook-wordcount * Fixed the broken link at in the user guide * Changed how travis builds the project * Added a conclusion * Went through and documented a lot of stuff * Added a preprocessors chapter and updated For Developers |
||
|---|---|---|
| .. | ||
| cli | ||
| for_developers | ||
| format | ||
| misc | ||
| README.md | ||
| SUMMARY.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