Mirrors/mdBook
2
0
Fork 0
mirror of https://github.com/rust-lang/mdBook synced 2025-01-07 10:18:44 +00:00
Code Issues Projects Releases Packages Wiki Activity
mdBook/book-example/src
History
Michael Bryan b4538da9c3
Merge pull request #802 from Bassetts/git-button 
Implement a git repository button
2018-10-23 19:16:45 +08:00
..
cli Rewrap guide markdown at 80 columns 2018-08-02 21:34:26 -05:00
for_developers Merge pull request #792 from rust-lang-nursery/custom-preprocessor 2018-10-16 00:02:12 +08:00
format Merge pull request #802 from Bassetts/git-button 2018-10-23 19:16:45 +08:00
misc Rewrap guide markdown at 80 columns 2018-08-02 21:34:26 -05:00
continuous-integration.md avoid using cd in example travis-ci script (#803) 2018-10-15 18:52:37 +08:00
README.md Rewrap guide markdown at 80 columns 2018-08-02 21:34:26 -05:00
SUMMARY.md user guide: Add instructions for running mdbook in CI 2018-06-22 10:31:49 -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.