Create book from markdown files. Like Gitbook but implemented in Rust
Go to file
Hugo McNally c6679053f7
Fixed bug with index page links.
If there is no index page in the source directory,
mdbook uses the first chapter as the index page.
When doing so, mdbook doesn't render the page any differently.
This causes relative links on the page to break,
if the first chapter is within a sub-directory.

To fix this, a redirect to the first chapter is used
instead of the copy of the page.
2024-01-25 18:33:07 +00:00
.github Update msrv to 1.70 2023-11-29 14:36:39 -08:00
ci Rewrite asset deploy. 2023-07-16 17:16:15 -07:00
examples upgrade clap to 4.0 2022-12-14 17:11:08 -08:00
guide Update to 0.4.36 2023-11-29 14:50:26 -08:00
src Fixed bug with index page links. 2024-01-25 18:33:07 +00:00
test_book Add Nim to default languages 2023-11-08 15:34:35 +01:00
tests Fixed bug with index page links. 2024-01-25 18:33:07 +00: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.36 2023-11-29 14:50:26 -08: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 Add Nim to default languages 2023-11-08 15:34:35 +01:00
Cargo.lock Update to 0.4.36 2023-11-29 14:50:26 -08:00
Cargo.toml Update to 0.4.36 2023-11-29 14:50:26 -08: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 issue templates and update contributor docs 2023-01-16 09:22:54 -08:00

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.