mdbook/test_book/src
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
..
headings Add sidebar heading navigation 2025-08-27 14:44:12 -07:00
individual fixed typo 'isn't is?' -> 'isn't it?' in test_book/src/individual/code.md 2025-06-08 23:42:42 +03:00
languages Add nix to default languages 2024-04-10 21:56:13 +02:00
rust Add rust specific codeblock examples 2021-10-05 12:11:29 +05:30
last.md Add sidebar heading navigation 2025-08-27 14:44:12 -07:00
prefix.md Setup basic structure for test book 2021-10-04 13:14:49 +05:30
README.md Setup basic structure for test book 2021-10-04 13:14:49 +05:30
suffix.md Setup basic structure for test book 2021-10-04 13:14:49 +05:30
SUMMARY.md Add sidebar heading navigation 2025-08-27 14:44:12 -07:00

Demo Book

This is a simple demo book, which is intended to be used for verifying and validating style changes in mdBook. This contains dummy examples of various markdown elements and code languages, so that one can check changes made in mdBook styles.

This rough outline is :

  • individual : contains basic markdown elements such as headings, paragraphs, links etc.
  • languages : contains a hello world in each of supported language to see changes in syntax highlighting
  • rust : contains language examples specific to rust, such as play pen, runnable examples etc.

This is more for checking and fixing style, rather than verifying that correct code is generated for given markdown, that is better handled in tests.