No description
Find a file
Eric Huss 1b55d4a389 Add sidebar heading navigation
This adds dynamic navigation of headers of the current page in the
sidebar. This is intended to help the user see what is on the current
page, and to be able to more easily navigate it. The "current" header is
tracked based on the scrolling behavior of the user, and is marked with
a small circle. This includes automatic folding to help keep it from
being too unwieldy on a page with a lot of nested headers.

This includes the `output.html.sidebar-header-nav` option to disable it.

I'm sure there are tweaks, fixes, and improvements that can be made. I'd
like to get this out now, and iterate on it over time to make
improvements.
2025-08-27 14:44:12 -07:00
.github Update to Rust 2024 2025-07-23 17:29:12 -07:00
ci Test more targets. 2024-05-16 17:27:28 -07:00
crates Add sidebar heading navigation 2025-08-27 14:44:12 -07:00
examples Rename Book.sections to Book.items 2025-08-22 18:51:04 -07:00
guide Add sidebar heading navigation 2025-08-27 14:44:12 -07:00
src Change CLI dest-dir to be relative to the current directory 2025-08-18 16:28:08 -07:00
test_book Add sidebar heading navigation 2025-08-27 14:44:12 -07:00
tests Add sidebar heading navigation 2025-08-27 14:44:12 -07:00
.git-blame-ignore-revs Add .git-blame-ignore-revs 2025-07-23 17:29:53 -07:00
.gitattributes Mark more font files as binary 2025-04-05 20:41:36 -04:00
.gitignore Add testsuite book directories to ignore list 2025-04-22 21:11:54 -07:00
Cargo.lock Add globs to test path names 2025-08-26 15:44:01 -07:00
Cargo.toml Add globs to test path names 2025-08-26 15:44:01 -07:00
CHANGELOG.md Update to 0.4.52 2025-07-14 15:45:55 -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 Use consistent sentence case for section headers 2025-08-16 14:59:05 -07:00
eslint.config.mjs Lint HBS JS templates 2025-08-25 15:15:47 -07:00
LICENSE Create LICENSE 2015-07-29 01:11:30 +02:00
package.json Add sidebar heading navigation 2025-08-27 14:44:12 -07:00
README.md README.md: update workflow status badge 2025-02-13 11:01:08 -05:00
rustfmt.toml Add rustfmt.toml 2025-07-23 17:29:55 -07:00
triagebot.toml Add more triagebot features 2025-03-23 13:04:10 -07:00

mdBook

CI 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.