mdbook/crates/mdbook-html
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
..
front-end Add sidebar heading navigation 2025-08-27 14:44:12 -07:00
src Add sidebar heading navigation 2025-08-27 14:44:12 -07:00
Cargo.toml Use embedded SVG instead of fonts for icons 2025-08-14 20:14:55 -07:00
README.md Add READMEs for all new crates 2025-07-23 17:47:31 -07:00

mdbook-html

Documentation crates.io Changelog

This is the HTML renderer for mdBook. This is intended for internal use only. It is automatically included by mdbook-driver to render books to HTML.

This crate is maintained by the mdBook team, primarily for use by mdBook and not intended for external use (except as a transitive dependency). This crate may make major changes to its APIs or be deprecated without warning.

License

Mozilla Public License, version 2.0