Load the sidebar toc from a shared JS file or iframe #2414

notriddle · 2024-07-16T01:52:07Z

Before this change, the Rust unstable-book is 88MiB. With this change, it becomes 15MiB. Other pages might not be as extreme, but it's expected to help any book like this.

This change is so drastic because, if every chapter has a link to every other chapter, the result is O(n²) text output.

Related to : https://rust-lang.zulipchat.com/#narrow/stream/266220-t-rustdoc/topic/Tracking.20overall.20size/near/431831262

Preview: http://notriddle.com/rustdoc-html-demo-9/on2-book/index.html

Loading filmscripts (green line is first contentful paint):

Desktop

Mobile

Before this change, the Rust `unstable-book` is 88MiB. With this change, it becomes 15MiB. Other pages might not be as extreme, but it's expected to help any book like this. This change is so drastic because, if every chapter has a link to every other chapter, the result is *O*(n<sup>2</sup>) text output.

GuillaumeGomez · 2024-07-16T09:20:27Z

This is awesome, thanks!

GuillaumeGomez · 2024-07-16T09:21:18Z

I have merge rights but I'm not sure I'm supposed to do it. I'll ask the dev-tools team.

notriddle · 2024-07-16T16:15:29Z

It’s not just that. The unresolved question is if making the sidebar dependent on JS is okay.

GuillaumeGomez · 2024-07-16T16:33:14Z

That's something that was mentioned on zulip. Not a maintainer so only my point of view: we can still browse the book without JS (although less efficiently), so the regression is "ok". Maybe we can have a middle-ground where only the big sections are provided by default and the rest is filled by JS?

notriddle · 2024-07-16T16:48:00Z

Another option: include the TOC in index.html, but require JS for every other page.

GuillaumeGomez · 2024-07-16T16:48:56Z

That however would be pretty bad.

Uses an iframe instead. The downside of iframes comes from them not necessarily being same-origin as the main page (particularly with `file:///` URLs), which can cause themes to fall out of sync, but that's not a problem here since themes don't work without JS anyway.

notriddle · 2024-07-16T20:18:08Z

Second commit has another solution to that problem: use an iframe. Those work without JavaScript.

I wind up using it as a fallback, instead of replacing the JS solution, because of Same-Origin-Policy shenanigans. Running out of a file:// URL will result in toc.html having separate localstorage from the main page, which isn't a problem when JS is disabled, but when it's enabled it would result in unsynchronized themes.

notriddle · 2024-10-01T20:21:14Z

r? @ehuss

ehuss

Thanks! I'm a little nervous about merging this since it is such a large change, and the added complexity is hard for me to maintain. I've also long felt that mdbook makes far too many requests (js and css files, etc.), and I am uncertain how this affects caching or performance in various scenarios. Another concern might be whether crawlers will be able to navigate properly. I'm also a little concerned over the amount of duplication in toc.html.hbs, which I feel will very likely get out of sync, or not get any testing.

However, I'll go ahead and merge with the understanding that you'll help with any issues, or else this is something that we can try to revert if necessary.

ehuss · 2024-11-06T18:35:07Z

@notriddle This seems to have broken a few things with folded sidebar entries. The folding doesn't work (clicking on the chapter heading doesn't expand it, and causes some rendering flashes). In some cases where I am able to get the folds to open, all the links are broken.

Some example books would be https://github.com/rust-lang/rustc-dev-guide or https://github.com/rust-lang/rust-by-example/.

Do you think you would be able to look at that?

GuillaumeGomez · 2024-11-06T19:47:28Z

The broken books are online already or not?

ehuss · 2024-11-06T21:21:48Z

No, you need to check out those repositories and use the latest mdbook in them.

Or, just enable the fold option in any book.

GuillaumeGomez · 2024-11-06T21:23:02Z

Ok, if @notriddle didn't answer by tomorrow, I'll take a look.

rust-lang/mdBook#2414

d3v-null · 2025-01-23T04:48:48Z

This change has broken how mdbook handles links in a sidebar.

e.g. if my summary / sidebar is

# Summary
[Introduction](README.md)
# User Guide
- [Introduction](user/intro.md)
- [Plot solutions](user/plotting.md)

in v0.4.40, the sidebar link will be given relative to the page you're on. if I'm on the user/intro.md page, then the sidebar href for the plotting link will be ../user/plotting.html , but after v0.4.41 where this change was released, there is no longer a relative link, instead, the href is user/plotting.html

GuillaumeGomez · 2025-01-23T09:44:36Z

We need to generate a sidebar in each "folder" then.

shenef · 2025-01-23T10:22:24Z

That may be the same issue as #2477 and #2482. It's very easily missed that the index.hbs file has to be updated.

d3v-null · 2025-01-24T03:38:36Z

thanks @shenef , unfortunately the person who set up mdbook is no longer around so it's not clear to me how to update index.hbs in my repo https://github.com/MWATelescope/mwa_hyperdrive

I tried mdbook init , which does update index.hbs but results in blank pages with mdbook serve

d3v-null · 2025-01-24T03:42:49Z

never mind, the above works, there was something else using that port.

- reran mdbook init --theme - keep playground improvements - keep language selector and suggest edit / edit to translation button text - improvement: toc is in separate js file, makes html file way smaller relevant upstream changes that are used: - rust-lang/mdBook#2414 - rust-lang/mdBook#2421 - rust-lang/mdBook#2454 - rust-lang/mdBook#2463

rust-lang/mdBook#2414

- reran mdbook init --theme - keep playground improvements - keep language selector and suggest edit / edit to translation button text - improvement: toc is in separate js file, makes html file way smaller - additionally updated to mdbook-i18n-helpers-0.3.5 relevant upstream changes that are used: - rust-lang/mdBook#2414 - rust-lang/mdBook#2421 - rust-lang/mdBook#2454 - rust-lang/mdBook#2463

mdbook in CI pipeline is updated to mdbook-0.4.44 - reran mdbook init --theme - keep playground improvements - keep language selector and suggest edit / edit to translation button text - improvement: toc is in separate js file, makes html file way smaller - additionally updated to mdbook-i18n-helpers-0.3.5 relevant upstream changes that are used: - rust-lang/mdBook#2414 - rust-lang/mdBook#2421 - rust-lang/mdBook#2454 - rust-lang/mdBook#2463

mdbook v0.4.41 后修改了加载侧边栏目录的逻辑，需要同步修改模板。目前模板与部署时使用的 mdbook 版本不匹配导致侧边栏链接错误。通过 mdbook init --theme 生成新模板替换目前模板。 link: rust-lang/mdBook#2414

…071 - 2025-09-21: Incorrect handling of embedded SVG and MathML leads to mutation XSS after removal) Summary: mdbook imports ammonia for which a vulnerability exist in v3, fortunately the current mdbook uses a fixed version so we can get rid of the vulnerability by upgrading its only dependant. # Changelog ## mdBook 0.4.52 [v0.4.51...v0.4.52](rust-lang/mdBook@v0.4.51...v0.4.52) **Note:** If you have a custom `index.hbs` theme file, it is recommended that you update it to the latest version to pick up the fixes in this release. ### Added - Added the ability to redirect `#` HTML fragments using the existing `output.html.redirect` table. [#2747](rust-lang/mdBook#2747) - Added the `rel="edit"` attribute to the edit page button. [#2702](rust-lang/mdBook#2702) ### Changed - The search index is now only loaded when the search input is opened instead of always being loaded. [#2553](rust-lang/mdBook#2553) [#2735](rust-lang/mdBook#2735) - The `mdbook serve` command has switched its underlying server library from warp to axum. [#2748](rust-lang/mdBook#2748) - Updated dependencies. [#2752](rust-lang/mdBook#2752) ### Fixed - The sidebar is now set to `display:none` when it is hidden in order to prevent the browser's search from thinking the sidebar's text is visible. [#2725](rust-lang/mdBook#2725) - Fixed search index URL not updating correctly when `hash-files` is enabled. [#2742](rust-lang/mdBook#2742) [#2746](rust-lang/mdBook#2746) - Fixed several sidebar animation bugs, particularly when manually resizing. [#2750](rust-lang/mdBook#2750) ## mdBook 0.4.51 [v0.4.50...v0.4.51](rust-lang/mdBook@v0.4.50...v0.4.51) ### Fixed - Fixed regression that broke the `S` search hotkey. [#2713](rust-lang/mdBook#2713) ## mdBook 0.4.50 [v0.4.49...v0.4.50](rust-lang/mdBook@v0.4.49...v0.4.50) ### Added - Added a keyboard shortcut help popup when pressing `?`. [#2608](rust-lang/mdBook#2608) ### Changed - Changed the look of the sidebar resize handle to match the new rustdoc format. [#2691](rust-lang/mdBook#2691) - `/` can now be used to open the search bar. [#2698](rust-lang/mdBook#2698) - Pressing enter from the search bar will navigate to the first entry. [#2698](rust-lang/mdBook#2698) - Updated `opener` to drop some dependencies. [#2709](rust-lang/mdBook#2709) - Updated dependencies, MSRV raised to 1.82. [#2711](rust-lang/mdBook#2711) ### Fixed - Fixed uncaught exception when pressing down when there are no search results. [#2698](rust-lang/mdBook#2698) - Fixed syntax highlighting of Rust code in the ACE editor. [#2710](rust-lang/mdBook#2710) ## mdBook 0.4.49 [v0.4.48...v0.4.49](rust-lang/mdBook@v0.4.48...v0.4.49) ### Added - Added a warning on unused fields in the root of `book.toml`. [#2622](rust-lang/mdBook#2622) ### Changed - Updated dependencies. [#2650](rust-lang/mdBook#2650) [#2688](rust-lang/mdBook#2688) - Updated minimum Rust version to 1.81. [#2688](rust-lang/mdBook#2688) - The unused `book.multilingual` field is no longer serialized, or shown in `mdbook init`. [#2689](rust-lang/mdBook#2689) - Speed up search index loading by using `JSON.parse` instead of parsing JavaScript. [#2633](rust-lang/mdBook#2633) ### Fixed - Search highlighting will not try to highlight in SVG `<text>` elements because it breaks the element. [#2668](rust-lang/mdBook#2668) - Fixed scrolling of the sidebar when a search highlight term is in the URL. [#2675](rust-lang/mdBook#2675) - Fixed issues when multiple footnote definitions use the same ID. Now, only one definition is used, and a warning is displayed. [#2681](rust-lang/mdBook#2681) - The sidebar is now restricted to 80% of the viewport width to make it possible to collapse it when the viewport is very narrow. [#2679](rust-lang/mdBook#2679) ## mdBook 0.4.48 [v0.4.47...v0.4.48](rust-lang/mdBook@v0.4.47...v0.4.48) ### Added - Footnotes now have back-reference links. These links bring the reader back to the original location. As part of this change, footnotes are now only rendered at the bottom of the page. This also includes some styling updates and fixes for footnote rendering. [#2626](rust-lang/mdBook#2626) - Added an "Auto" theme selection option which will default to the system-preferred mode. This will also automatically switch when the system changes the preferred mode. [#2576](rust-lang/mdBook#2576) ### Changed - The `searchindex.json` file has been removed; only the `searchindex.js` file will be generated. [#2552](rust-lang/mdBook#2552) - Updated Javascript code to use eslint. [#2554](rust-lang/mdBook#2554) - An error is generated if there are duplicate files in `SUMMARY.md`. [#2613](rust-lang/mdBook#2613) ## mdBook 0.4.47 [v0.4.46...v0.4.47](rust-lang/mdBook@v0.4.46...v0.4.47) ### Fixed - Fixed search not showing up in sub-directories. [#2586](rust-lang/mdBook#2586) ## mdBook 0.4.46 [v0.4.45...v0.4.46](rust-lang/mdBook@v0.4.45...v0.4.46) ### Changed - The `output.html.hash-files` config option has been added to add hashes to static filenames to bust any caches when a book is updated. `{{resource}}` template tags have been added so that links can be properly generated to those files. [#1368](rust-lang/mdBook#1368) ### Fixed - Playground links for Rust 2024 now set the edition correctly. [#2557](rust-lang/mdBook#2557) ## mdBook 0.4.45 [v0.4.44...v0.4.45](rust-lang/mdBook@v0.4.44...v0.4.45) ### Changed - Added context to error message when rustdoc is not found. [#2545](rust-lang/mdBook#2545) - Slightly changed the styling rules around margins of footnotes. [#2524](rust-lang/mdBook#2524) ### Fixed - Fixed an issue where it would panic if a source_path is not set. [#2550](rust-lang/mdBook#2550) ## mdBook 0.4.44 [v0.4.43...v0.4.44](rust-lang/mdBook@v0.4.43...v0.4.44) ### Added - Added pre-built aarch64-apple-darwin binaries to the releases. [#2500](rust-lang/mdBook#2500) - `mdbook clean` now shows a summary of what it did. [#2458](rust-lang/mdBook#2458) - Added the `output.html.search.chapter` config setting to disable search indexing of individual chapters. [#2533](rust-lang/mdBook#2533) ### Fixed - Fixed auto-scrolling the side-bar when loading a page with a `#` fragment URL. [#2517](rust-lang/mdBook#2517) - Fixed display of sidebar when javascript is disabled. [#2529](rust-lang/mdBook#2529) - Fixed the sidebar visibility getting out of sync with the button. [#2532](rust-lang/mdBook#2532) ### Changed - ❗ Rust code block hidden lines now follow the same logic as rustdoc. This requires a space after the `#` symbol. [#2530](rust-lang/mdBook#2530) - ❗ Updated the Linux pre-built binaries which requires a newer version of glibc (2.34). [#2523](rust-lang/mdBook#2523) - Updated dependencies [#2538](rust-lang/mdBook#2538) [#2539](rust-lang/mdBook#2539) ## mdBook 0.4.43 [v0.4.42...v0.4.43](rust-lang/mdBook@v0.4.42...v0.4.43) ### Fixed - Fixed setting the title in `mdbook init` when no git user is configured. [#2486](rust-lang/mdBook#2486) ### Changed - The Rust 2024 edition no longer needs `-Zunstable-options`. [#2495](rust-lang/mdBook#2495) ## mdBook 0.4.42 [v0.4.41...v0.4.42](rust-lang/mdBook@v0.4.41...v0.4.42) ### Fixed - Fixed chapter list folding. [#2473](rust-lang/mdBook#2473) ## mdBook 0.4.41 [v0.4.40...v0.4.41](rust-lang/mdBook@v0.4.40...v0.4.41) **Note:** If you have a custom `index.hbs` theme file, you will need to update it to the latest version. ### Added - Added preliminary support for Rust 2024 edition. [#2398](rust-lang/mdBook#2398) - Added a full example of the remove-emphasis preprocessor. [#2464](rust-lang/mdBook#2464) ### Changed - Adjusted styling of clipboard/play icons. [#2421](rust-lang/mdBook#2421) - Updated to handlebars v6. [#2416](rust-lang/mdBook#2416) - Attr and section rules now have specific code highlighting. [#2448](rust-lang/mdBook#2448) - The sidebar is now loaded from a common file, significantly reducing the book size when there are many chapters. [#2414](rust-lang/mdBook#2414) - Updated dependencies. [#2470](rust-lang/mdBook#2470) ### Fixed - Improved theme support when JavaScript is disabled. [#2454](rust-lang/mdBook#2454) - Fixed broken themes when localStorage has an invalid theme id. [#2463](rust-lang/mdBook#2463) - Adjusted the line-height of superscripts (and footnotes) to avoid adding extra space between lines. [#2465](rust-lang/mdBook#2465) ## mdBook 0.4.40 [v0.4.39...v0.4.40](rust-lang/mdBook@v0.4.39...v0.4.40) ### Fixed - Reverted the update to pulldown-cmark which broke the semver API. [#2388](rust-lang/mdBook#2388) ## mdBook 0.4.39 [v0.4.38...v0.4.39](rust-lang/mdBook@v0.4.38...v0.4.39) ### Fixed - Fixed the automatic deploy broken in the previous release. [#2383](rust-lang/mdBook#2383) ## mdBook 0.4.38 [v0.4.37...v0.4.38](rust-lang/mdBook@v0.4.37...v0.4.38) ### Added - Added `nix` to the default set of languages supported for syntax highlighting. [#2262](rust-lang/mdBook#2262) ### Changed - The `output.html.curly-quotes` option has been renamed to `output.html.smart-punctuation` to better reflect what it does. The old option `curly-quotes` is kept for compatibility, but may be removed in the future. [#2327](rust-lang/mdBook#2327) - The file-watcher used in `mdbook serve` and `mdbook watch` now uses a poll-based watcher instead of the native operating system notifications. This should fix issues on various systems and environments, and more accurately detect when files change. The native watcher can still be used with the `--watcher native` CLI option. [#2325](rust-lang/mdBook#2325) - `mdbook test` output now includes color, and shows relative paths to the source. [#2259](rust-lang/mdBook#2259) - Updated dependencies, MSRV raised to 1.74 [#2350](rust-lang/mdBook#2350) [#2351](rust-lang/mdBook#2351) [#2378](rust-lang/mdBook#2378) [#2381](rust-lang/mdBook#2381) ### Fixed - Reduced memory allocation when copying files. [#2355](rust-lang/mdBook#2355) - Fixed the horizontal divider in `SUMMARY.md` from being indented into the previous nested section. [#2364](rust-lang/mdBook#2364) - Removed unnecessary `import` in the CSS. [#2260](rust-lang/mdBook#2260) ## mdBook 0.4.37 [v0.4.36...v0.4.37](rust-lang/mdBook@v0.4.36...v0.4.37) ### Changed - ❗️ Updated the markdown parser. This brings in many changes to more closely follow the CommonMark spec. This may cause some small rendering changes. It is recommended to compare the output of the old and new version to check for changes. See <https://github.com/raphlinus/pulldown-cmark/releases/tag/v0.10.0> for more information. [#2308](rust-lang/mdBook#2308) - The warning about the legacy `src/theme` directory has been removed. [#2263](rust-lang/mdBook#2263) - Updated dependencies. MSRV raised to 1.71.0. [#2283](rust-lang/mdBook#2283) [#2293](rust-lang/mdBook#2293) [#2297](rust-lang/mdBook#2297) [#2310](rust-lang/mdBook#2310) [#2309](rust-lang/mdBook#2309) - Some internal performance/memory improvements. [#2273](rust-lang/mdBook#2273) [#2290](rust-lang/mdBook#2290) - Made the `pathdiff` dependency optional based on the `watch` feature. [#2291](rust-lang/mdBook#2291) ### Fixed - The `s` shortcut key handler should not trigger when focus is in an HTML form. [#2311](rust-lang/mdBook#2311) ## mdBook 0.4.36 [v0.4.35...v0.4.36](rust-lang/mdBook@v0.4.35...v0.4.36) ### Added - Added Nim to the default highlighted languages. [#2232](rust-lang/mdBook#2232) - Added a small indicator for the sidebar resize handle. [#2209](rust-lang/mdBook#2209) ### Changed - Updated dependencies. MSRV raised to 1.70.0. [#2173](rust-lang/mdBook#2173) [#2250](rust-lang/mdBook#2250) [#2252](rust-lang/mdBook#2252) ### Fixed - Fixed blank column in print page when the sidebar was visible. [#2235](rust-lang/mdBook#2235) - Fixed indentation of code blocks when Javascript is disabled. [#2162](rust-lang/mdBook#2162) - Fixed a panic when `mdbook serve` or `mdbook watch` were given certain kinds of paths. [#2229](rust-lang/mdBook#2229) ## mdBook 0.4.35 [v0.4.34...v0.4.35](rust-lang/mdBook@v0.4.34...v0.4.35) ### Added - Added the `book.text-direction` setting for explicit support for right-to-left languages. [#1641](rust-lang/mdBook#1641) - Added `rel=prefetch` to the "next" links to potentially improve browser performance. [#2168](rust-lang/mdBook#2168) - Added a `.warning` CSS class which is styled for displaying warning blocks. [#2187](rust-lang/mdBook#2187) ### Changed - Better support of the sidebar when JavaScript is disabled. [#2175](rust-lang/mdBook#2175) ## mdBook 0.4.34 [v0.4.33...v0.4.34](rust-lang/mdBook@v0.4.33...v0.4.34) ### Fixed - Fixed file change watcher failing on macOS with a large number of files. [#2157](rust-lang/mdBook#2157) ## mdBook 0.4.33 [v0.4.32...v0.4.33](rust-lang/mdBook@v0.4.32...v0.4.33) ### Added - The `color-scheme` CSS property is now set based on the light/dark theme, which applies some slight color differences in browser elements like scroll bars on some browsers. [#2134](rust-lang/mdBook#2134) ### Fixed - Fixed watching of extra-watch-dirs when not running in the book root directory. [#2146](rust-lang/mdBook#2146) - Reverted the dependency update to the `toml` crate (again!). This was an unintentional breaking change in 0.4.32. [#2021](rust-lang/mdBook#2021) - Changed macOS change notifications to use the kqueue implementation which should fix some issues with repeated rebuilds when a file changed. [#2152](rust-lang/mdBook#2152) - Don't set a background color in the print page for code blocks in a header. [#2150](rust-lang/mdBook#2150) ## mdBook 0.4.32 [v0.4.31...v0.4.32](rust-lang/mdBook@v0.4.31...v0.4.32) ### Fixed - Fixed theme-color meta tag not syncing with the theme. [#2118](rust-lang/mdBook#2118) ### Changed - Updated all dependencies. [#2121](rust-lang/mdBook#2121) [#2122](rust-lang/mdBook#2122) [#2123](rust-lang/mdBook#2123) [#2124](rust-lang/mdBook#2124) [#2125](rust-lang/mdBook#2125) [#2126](rust-lang/mdBook#2126) ## mdBook 0.4.31 [v0.4.30...v0.4.31](rust-lang/mdBook@v0.4.30...v0.4.31) ### Fixed - Fixed menu border render flash during page navigation. [#2101](rust-lang/mdBook#2101) - Fixed flicker setting sidebar scroll position. [#2104](rust-lang/mdBook#2104) - Fixed compile error with proc-macro2 on latest Rust nightly. [#2109](rust-lang/mdBook#2109) ## mdBook 0.4.30 [v0.4.29...v0.4.30](rust-lang/mdBook@v0.4.29...v0.4.30) ### Added - Added support for heading attributes. Attributes are specified in curly braces just after the heading text. An HTML ID can be specified with `#` and classes with `.`. For example: `## My heading {#custom-id .class1 .class2}` [#2013](rust-lang/mdBook#2013) - Added support for hidden code lines for languages other than Rust. The `output.html.code.hidelines` table allows you to define the prefix character that will be used to hide code lines based on the language. [#2093](rust-lang/mdBook#2093) ### Fixed - Fixed a few minor markdown rendering issues. [#2092](rust-lang/mdBook#2092) ## mdBook 0.4.29 [v0.4.28...v0.4.29](rust-lang/mdBook@v0.4.28...v0.4.29) ### Changed - Built-in fonts are no longer copied when `fonts/fonts.css` is overridden in the theme directory. Additionally, the warning about `copy-fonts` has been removed if `fonts/fonts.css` is specified. [#2080](rust-lang/mdBook#2080) - `mdbook init --force` now skips all interactive prompts as intended. [#2057](rust-lang/mdBook#2057) - Updated dependencies [#2063](rust-lang/mdBook#2063) [#2086](rust-lang/mdBook#2086) [#2082](rust-lang/mdBook#2082) [#2084](rust-lang/mdBook#2084) [#2085](rust-lang/mdBook#2085) ### Fixed - Switched from the `gitignore` library to `ignore`. This should bring some improvements with gitignore handling. [#2076](rust-lang/mdBook#2076) ## mdBook 0.4.28 [v0.4.27...v0.4.28](rust-lang/mdBook@v0.4.27...v0.4.28) ### Changed - The sidebar is now shown on wide screens when localstorage is disabled. [#2017](rust-lang/mdBook#2017) - Preprocessors are now run with `mdbook test`. [#1986](rust-lang/mdBook#1986) ### Fixed - Fixed regression in 0.4.26 that prevented the title bar from scrolling properly on smaller screens. [#2039](rust-lang/mdBook#2039) ## mdBook 0.4.27 [v0.4.26...v0.4.27](rust-lang/mdBook@v0.4.26...v0.4.27) ### Changed - Reverted the dependency update to the `toml` crate. This was an unintentional breaking change in 0.4.26. [#2021](rust-lang/mdBook#2021) ## mdBook 0.4.26 [v0.4.25...v0.4.26](rust-lang/mdBook@v0.4.25...v0.4.26) **The 0.4.26 release has been yanked due to an unintentional breaking change.** ### Changed - Removed custom scrollbars for webkit browsers [#1961](rust-lang/mdBook#1961) - Updated some dependencies [#1998](rust-lang/mdBook#1998) [#2009](rust-lang/mdBook#2009) [#2011](rust-lang/mdBook#2011) - Fonts are now part of the theme. The `output.html.copy-fonts` option has been deprecated. To define custom fonts, be sure to define `theme/fonts.css`. [#1987](rust-lang/mdBook#1987) ### Fixed - Fixed overflow viewport issue with mobile Safari [#1994](rust-lang/mdBook#1994) ## mdBook 0.4.25 [e14d381...1ba74a3](rust-lang/mdBook@e14d381...1ba74a3) ### Fixed - Fixed a regression where `mdbook test -L deps path-to-book` would not work. [#1959](rust-lang/mdBook#1959) ## mdBook 0.4.24 [eb77083...8767ebf](rust-lang/mdBook@eb77083...8767ebf) ### Fixed - The precompiled linux-gnu mdbook binary available on [GitHub Releases](https://github.com/rust-lang/mdBook/releases) inadvertently switched to a newer version of glibc. This release goes back to an older version that should be more compatible on older versions of Linux. [#1955](rust-lang/mdBook#1955) ## mdBook 0.4.23 [678b469...68a75da](rust-lang/mdBook@678b469...68a75da) ### Changed - Updated all dependencies [#1951](rust-lang/mdBook#1951) [#1952](rust-lang/mdBook#1952) [#1844](rust-lang/mdBook#1844) - Updated minimum Rust version to 1.60. [#1951](rust-lang/mdBook#1951) ### Fixed - Fixed a regression where playground code was missing hidden lines, preventing it from compiling correctly. [#1950](rust-lang/mdBook#1950) ## mdBook 0.4.22 [40c06f5...4844f72](rust-lang/mdBook@40c06f5...4844f72) ### Added - Added a `--chapter` option to `mdbook test` to specify a specific chapter to test. [#1741](rust-lang/mdBook#1741) - Added CSS styling for `<kbd>` tags. [#1906](rust-lang/mdBook#1906) - Added pre-compiled binaries for `x86_64-unknown-linux-musl` and `aarch64-unknown-linux-musl` (see [Releases](https://github.com/rust-lang/mdBook/releases)). [#1862](rust-lang/mdBook#1862) - Added `build.extra-watch-dirs` which is an array of additional directories to watch for changes when running `mdbook serve`. [#1884](rust-lang/mdBook#1884) ### Changed - Removed the `type="text/javascript"` attribute from `<script>` tags. [#1881](rust-lang/mdBook#1881) - Switched to building with Rust Edition 2021. This raises the minimum supported Rust version to 1.56. [#1887](rust-lang/mdBook#1887) - When hidden code is hidden, the hidden parts are no longer copied to the clipboard via the copy button. [#1911](rust-lang/mdBook#1911) - Various HTML changes and fixes to be more compliant with HTML5. [#1924](rust-lang/mdBook#1924) - The theme picker now shows which theme is currently selected. [#1935](rust-lang/mdBook#1935) ### Fixed - Avoid blank line at the end of an ACE code block [#1836](rust-lang/mdBook#1836) Reviewed By: kuecks Differential Revision: D83200549 fbshipit-source-id: 55b4adb5f5c9588c9b2b772f1b82909afe8c03cd

mdbook v0.4.41 后修改了加载侧边栏目录的逻辑，需要同步修改模板。目前模板与部署时使用的 mdbook 版本不匹配导致侧边栏链接错误。通过 mdbook init --theme 生成新模板替换目前模板。 link: rust-lang/mdBook#2414

rustbot added the S-waiting-on-review Status: waiting on a review label Jul 16, 2024

GuillaumeGomez approved these changes Jul 16, 2024

View reviewed changes

notriddle force-pushed the on2 branch from 34dc0a8 to 203685e Compare July 16, 2024 19:38

notriddle changed the title ~~Load the sidebar toc from a shared JS file~~ Load the sidebar toc from a shared JS file or iframe Oct 1, 2024

ehuss approved these changes Nov 2, 2024

View reviewed changes

ehuss added this pull request to the merge queue Nov 2, 2024

Merged via the queue into rust-lang:master with commit 271bbba Nov 3, 2024

notriddle deleted the on2 branch November 3, 2024 02:07

notriddle mentioned this pull request Nov 6, 2024

Fix inadvertently broken folding behavior #2473

Merged

Kijewski mentioned this pull request Nov 9, 2024

book: update-theme.py needs updating askama-rs/askama#227

Closed

wilwade mentioned this pull request Nov 19, 2024

site-url not respected in links #1764

Open

ehuss mentioned this pull request Dec 31, 2024

Fragments in URLs break sidebar auto-scrolling #2515

Closed

d3v-null added a commit to MWATelescope/mwa_hyperdrive that referenced this pull request Jan 23, 2025

fix broken mdbook sidebar

896d72e

rust-lang/mdBook#2414

d3v-null mentioned this pull request Jan 23, 2025

Many dead link in the online documentations MWATelescope/mwa_hyperdrive#44

Closed

michael-kerscher mentioned this pull request Jan 31, 2025

update to mdbook-0.4.44 and sync book.js and index.hbs google/comprehensive-rust#2610

Merged

d3v-null added a commit to MWATelescope/mwa_hyperdrive that referenced this pull request Feb 2, 2025

fix broken mdbook sidebar

01a5d6e

rust-lang/mdBook#2414

chriskrycho mentioned this pull request Mar 3, 2025

The book requires js to fetch content rust-lang/book#4255

Closed

ehuss mentioned this pull request Apr 19, 2025

folded chapters don't expand with highlight in URL #2671

Closed

notriddle mentioned this pull request Aug 27, 2025

storage optimization with shared side-bar in the html #1931

Closed

This was referenced Sep 4, 2025

fix: update template by mdbook v0.4.52 RadxaOS-SDK/rsdk#85

Merged

rsdk 文档链接错误 RadxaOS-SDK/rsdk#86

Closed

Load the sidebar toc from a shared JS file or iframe #2414

Load the sidebar toc from a shared JS file or iframe #2414

Uh oh!

Conversation

notriddle commented Jul 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

GuillaumeGomez commented Jul 16, 2024

Uh oh!

GuillaumeGomez commented Jul 16, 2024

Uh oh!

notriddle commented Jul 16, 2024

Uh oh!

GuillaumeGomez commented Jul 16, 2024

Uh oh!

notriddle commented Jul 16, 2024

Uh oh!

GuillaumeGomez commented Jul 16, 2024

Uh oh!

notriddle commented Jul 16, 2024

Uh oh!

notriddle commented Oct 1, 2024

Uh oh!

ehuss left a comment

Choose a reason for hiding this comment

Uh oh!

ehuss commented Nov 6, 2024

Uh oh!

GuillaumeGomez commented Nov 6, 2024

Uh oh!

ehuss commented Nov 6, 2024

Uh oh!

GuillaumeGomez commented Nov 6, 2024

Uh oh!

d3v-null commented Jan 23, 2025

Uh oh!

GuillaumeGomez commented Jan 23, 2025

Uh oh!

shenef commented Jan 23, 2025

Uh oh!

d3v-null commented Jan 24, 2025

Uh oh!

d3v-null commented Jan 24, 2025

Uh oh!

Uh oh!

notriddle commented Jul 16, 2024 •

edited

Loading