Create book from markdown files. Like Gitbook but implemented in Rust
Go to file
Michael Howell 7560a2b9b6 Use embedded SVG instead of fonts for icons
The [downsides of icon fonts] are well-documented, and also, why ship all of
the icons when it only uses 14?

[downsides of icon fonts]: https://speakerdeck.com/ninjanails/death-to-icon-fonts
2022-09-18 15:04:05 -07:00
.github/workflows Require Rust 2021 edition 2022-09-09 16:00:35 +02: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 add a --chapter option to mdbook test. (#1741) 2022-08-25 19:13:51 -07:00
src Use embedded SVG instead of fonts for icons 2022-09-18 15:04:05 -07:00
test_book Add rust specific codeblock examples 2021-10-05 12:11:29 +05:30
tests add a --chapter option to mdbook test. (#1741) 2022-08-25 19:13:51 -07: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.21 2022-07-22 10:54:53 -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 Use embedded SVG instead of fonts for icons 2022-09-18 15:04:05 -07:00
Cargo.toml Use embedded SVG instead of fonts for icons 2022-09-18 15:04:05 -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.