jesus/mdbook
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
mdbook/book-example/src
History
Carol (Nichols || Goulding) ac1749ff2f Implement a rustdoc_include preprocessor (#1003) 
* Allow underscores in the link type name

* Add some tests for include anchors

* Include parts of Rust files and hide the rest

Fixes #618.

* Increase min supported Rust version to 1.35

* Add a test for a behavior of rustdoc_include I want to depend on

At first I thought this was a bug, but then I looked at some use cases
we have in TRPL and decided this was a feature that I'd like to use.
2019-10-06 00:27:03 +02:00
..
cli Correct grammar: remove the redundancy 2019-04-12 22:53:21 +08:00
for_developers Merge pull request #985 from Michael-F-Bryan/enable-caching 2019-08-07 10:26:06 -07:00
format Implement a rustdoc_include preprocessor (#1003) 2019-10-06 00:27:03 +02:00
misc Rewrap guide markdown at 80 columns 2018-08-02 21:34:26 -05:00
continuous-integration.md Release 0.3.0 2019-06-18 15:24:26 -07: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

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.