Create book from markdown files. Like Gitbook but implemented in Rust
Go to file
mitchmindtree 13035baeae Workaround rust nightly borrowcheck error (#1860)
Surprisingly, this fixes the error filed at #1860!

This seems suspicious, perhaps indicative of a bug in Rust's non-lexical
lifetime handling?

The lifetimes in the `handlebars::Renderable::render` method signature
are quite complicated, and its unclear to me whether or not Rust is
catching some new safety edge-case that wasn't previously handled
correctly...

Possibly related to `drop` order, which I *think* is related to the
order of binding statements?
2022-07-22 15:15:12 +10:00
.github/workflows chore: Upgrade MSRV 2022-03-28 13:06:44 -05:00
ci Update deprecated GitHub Actions commands. 2020-10-08 10:00:06 -07:00
examples refactor: Move from deprecated SubCommand 2022-03-28 13:06:50 -05:00
guide Update to 0.4.20 2022-07-14 13:46:56 -07:00
src Workaround rust nightly borrowcheck error (#1860) 2022-07-22 15:15:12 +10:00
test_book Add rust specific codeblock examples 2021-10-05 12:11:29 +05:30
tests Make link to first chapter active in index page 2022-06-29 23:51:18 +02:00
.gitattributes Explicitly mark fonts and images files as binary (#951) 2019-06-11 21:44:15 +02:00
.gitignore Setup basic structure for test book 2021-10-04 13:14:49 +05:30
CHANGELOG.md Update to 0.4.20 2022-07-14 13:46:56 -07:00
CODE_OF_CONDUCT.md add explicit code of conduct, copying other rust-lang repos 2021-07-26 11:52:24 -07:00
CONTRIBUTING.md Update documentation 2021-12-19 20:26:37 -08:00
Cargo.lock Update to 0.4.20 2022-07-14 13:46:56 -07:00
Cargo.toml Update to 0.4.20 2022-07-14 13:46:56 -07:00
LICENSE Create LICENSE 2015-07-29 01:11:30 +02:00
README.md Update documentation 2021-12-19 20:26:37 -08:00
release.toml Metadata for cargo-release should be in release.toml (#722) 2018-07-09 18:36:55 +08:00
triagebot.toml Add minimal traigebot config 2021-10-27 19:31:08 +05:30

README.md

mdBook

Build Status crates.io LICENSE

mdBook is a utility to create modern online books from Markdown files.

Check out the User Guide for a list of features and installation and usage information. The User Guide also serves as a demonstration to showcase what a book looks like.

If you are interested in contributing to the development of mdBook, check out the Contribution Guide.

License

All the code in this repository is released under the Mozilla Public License v2.0, for more information take a look at the LICENSE file.