History

Matt Ickstadt b2ad669c61 Search with Elasticlunr, updated (#604 ) * Add search with elasticlunr.js This commit adds search functionality to mdBook, based on work done by @phaiax. The in-browser search code uses elasticlunr.js to execute the search, using an index generated at book build time by elasticlunr-rs. * Add generator comment Someone on Reddit was wondering how the rust book was generated and said they checked the source. Thought I'd put this here. Might be a good idea to have a little footer "made with mdBook", but this'll do for now. * Remove search/editor file override behavior * Use for loop for book iterator * Improve HTML regex * Fix search CORS in file URIs * Use ammonia to sanitize HTML * Filter html5ever log messages		2018-03-07 21:02:06 +08:00
..
cli	Update documentation to reflect addition of `clean` subcommand. (#607 )	2018-02-18 15:04:04 +08:00
for_developers	Add complete preprocessor example (#629 )	2018-02-24 18:14:52 +08:00
format	Search with Elasticlunr, updated (#604 )	2018-03-07 21:02:06 +08:00
misc	Search with Elasticlunr, updated (#604 )	2018-03-07 21:02:06 +08:00
README.md	updated links from azerupi to rust-lang-nursery (#489 )	2017-11-22 11:35:18 +01:00
SUMMARY.md	Update documentation to reflect addition of `clean` subcommand. (#607 )	2018-02-18 15:04:04 +08: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