History

Liam Beckman e48fed74bf Add `--path .` to cargo install commands. Changing `cargo install` to `cargo install --path .` prevents the following error: <span style="color: red;">error:</span> Using `cargo install` to install the binaries for the package in current working directory is no longer supported, use `cargo install --path .` instead. Use `cargo build` if you want to simply build the package.		2019-07-31 14:49:25 -07:00
..
cli	Correct grammar: remove the redundancy	2019-04-12 22:53:21 +08:00
for_developers	Add `--path .` to cargo install commands.	2019-07-31 14:49:25 -07:00
format	Remove redundant occurrence of 'in the'	2019-07-17 17:20:18 +02:00
misc	Rewrap guide markdown at 80 columns	2018-08-02 21:34:26 -05:00
README.md	Rewrap guide markdown at 80 columns	2018-08-02 21:34:26 -05:00
SUMMARY.md	Issue 703 (#929 )	2019-05-19 22:16:10 +02:00
continuous-integration.md	Release 0.3.0	2019-06-18 15:24:26 -07: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.