a873d46871
Use case: when trying to `mdbook test` a file that has many `include` directives, and a test fails, the line numbers in the `rustdoc` output don't match the line numbers in the original markdown file. Turning on the markdown renderer implemented here lets you see what is being passed to `rustdoc` by saving the markdown after the preprocessors have run. This renderer could be helpful for debugging many preprocessors, but it's probably not useful in the general case, so it's turned off by default. |
||
|---|---|---|
| .. | ||
| cli | ||
| for_developers | ||
| format | ||
| misc | ||
| README.md | ||
| SUMMARY.md | ||
| continuous-integration.md | ||
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.