Create book from markdown files. Like Gitbook but implemented in Rust
Go to file
Em Zhan 72b3227824 Fix flicker when setting sidebar scroll position
Previously, sidebar scroll was set in an external script which caused a
flicker as the sidebar is initially rendered without any scroll before
being scrolled to the desired location.

Switching to an inline script right after the HTML tags for the sidebar
seems to avoid the flicker in most cases. In addition, logic is added to
avoid scrolling jumps when navigating via links within the sidebar.
2023-06-21 19:25:21 -05:00
.github Raise MSRV to 1.65 2023-05-13 09:41:10 -07:00
ci Also make sure releases use --locked 2023-02-13 07:53:32 -08:00
examples upgrade clap to 4.0 2022-12-14 17:11:08 -08:00
guide main branch is not always "master" these days 2023-06-07 18:47:15 +02:00
src Fix flicker when setting sidebar scroll position 2023-06-21 19:25:21 -05:00
test_book Add a test to the test_book for custom heading attributes 2023-05-28 11:33:24 -07:00
tests Fix search for custom heading attributes 2023-05-28 12:03:03 -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.30 2023-05-28 14:54:05 -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 Add issue templates and update contributor docs 2023-01-16 09:22:54 -08:00
Cargo.lock Update to 0.4.30 2023-05-28 14:54:05 -07:00
Cargo.toml Update to 0.4.30 2023-05-28 14:54: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 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.