jesus/mdbook
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
mdbook/crates/mdbook-html/front-end/templates/index.hbs

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

368 lines
16 KiB
Handlebars
Raw Normal View History

First big step for the html renderer, it reads an handlebars template and creates the files from SUMMARY.md respecting the source folder structure
2015-07-19 00:08:38 +02:00
<!DOCTYPE HTML>
Improve theme support when JS is disabled
2024-10-23 18:16:52 +02:00
<html lang="{{ language }}" class="{{ default_theme }} sidebar-visible" dir="{{ text_direction }}">
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
<head>
<!-- Book generated using mdBook -->
<meta charset="UTF-8">
<title>{{ title }}</title>
{{#if is_print }}
Update index.hbs Trailing slash on void elements has no effect and interacts badly with unquoted attribute values.
2023-09-19 20:44:39 +06:00
<meta name="robots" content="noindex">
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
{{/if}}
Add the config parameter output.html.site-url to set base url of the 404 page, making links and relative script/css loads behave correctly even in subdirectory paths
2020-06-07 14:14:35 +02:00
{{#if base_url}}
<base href="{{ base_url }}">
{{/if}}
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
<!-- Custom HTML head -->
{{> head}}
<meta name="description" content="{{ description }}">
<meta name="viewport" content="width=device-width, initial-scale=1">
Update index.hbs Trailing slash on void elements has no effect and interacts badly with unquoted attribute values.
2023-09-19 20:44:39 +06:00
<meta name="theme-color" content="#ffffff">
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
Fix favicon when only one is overridden. A mistake in #1266, I neglected to also update the <link> generation to elide the link if one of the favicon images is not included.
2020-07-07 13:37:25 -07:00
{{#if favicon_svg}}
feat(html): cache bust static files by adding hashes to file names Closes rust-lang#1254
2025-02-13 10:04:21 -07:00
<link rel="icon" href="{{ resource "favicon.svg" }}">
Fix favicon when only one is overridden. A mistake in #1266, I neglected to also update the <link> generation to elide the link if one of the favicon images is not included.
2020-07-07 13:37:25 -07:00
{{/if}}
{{#if favicon_png}}
feat(html): cache bust static files by adding hashes to file names Closes rust-lang#1254
2025-02-13 10:04:21 -07:00
<link rel="shortcut icon" href="{{ resource "favicon.png" }}">
Fix favicon when only one is overridden. A mistake in #1266, I neglected to also update the <link> generation to elide the link if one of the favicon images is not included.
2020-07-07 13:37:25 -07:00
{{/if}}
feat(html): cache bust static files by adding hashes to file names Closes rust-lang#1254
2025-02-13 10:04:21 -07:00
<link rel="stylesheet" href="{{ resource "css/variables.css" }}">
<link rel="stylesheet" href="{{ resource "css/general.css" }}">
<link rel="stylesheet" href="{{ resource "css/chrome.css" }}">
Add config option to disable print html, css, and icon
2020-03-30 10:38:37 +02:00
{{#if print_enable}}
feat(html): cache bust static files by adding hashes to file names Closes rust-lang#1254
2025-02-13 10:04:21 -07:00
<link rel="stylesheet" href="{{ resource "css/print.css" }}" media="print">
Add config option to disable print html, css, and icon
2020-03-30 10:38:37 +02:00
{{/if}}
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
<!-- Fonts -->
feat(html): cache bust static files by adding hashes to file names Closes rust-lang#1254
2025-02-13 10:04:21 -07:00
<link rel="stylesheet" href="{{ resource "fonts/fonts.css" }}">
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
<!-- Highlight.js Stylesheets -->
Change all HTML IDs to have a prefix This changes all HTML IDs so that they have the `mdbook-` prefix. This should help avoid ID conflicts between internal IDs and IDs from user content such as section headers. This is a relatively disruptive change and has a high risk of breaking something. However, I think I have covered everything, and if anything is missed, hopefully it will get detected. I did not change class names since the chance of a collision is much smaller than with IDs. However, that is something that could be considered in the future. Closes https://github.com/rust-lang/mdBook/issues/880
2025-08-19 19:38:22 -07:00
<link rel="stylesheet" id="mdbook-highlight-css" href="{{ resource "highlight.css" }}">
<link rel="stylesheet" id="mdbook-tomorrow-night-css" href="{{ resource "tomorrow-night.css" }}">
<link rel="stylesheet" id="mdbook-ayu-highlight-css" href="{{ resource "ayu-highlight.css" }}">
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
<!-- Custom theme stylesheets -->
{{#each additional_css}}
feat(html): cache bust static files by adding hashes to file names Closes rust-lang#1254
2025-02-13 10:04:21 -07:00
<link rel="stylesheet" href="{{ resource this }}">
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
{{/each}}
{{#if mathjax_support}}
<!-- MathJax -->
Remove unneeded type attribute for <script>
2022-08-29 21:07:50 +02:00
<script async src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
{{/if}}
Fix inadvertently broken folding behavior
2024-11-06 14:56:49 -07:00
Switch theme when preferred color scheme changes
2025-03-07 23:10:41 -07:00
<!-- Provide site root and default themes to javascript -->
Remove unneeded type attribute for <script>
2022-08-29 21:07:50 +02:00
<script>
Fix eslint warnings
2025-02-21 22:55:23 +01:00
const path_to_root = "{{ path_to_root }}";
Switch theme when preferred color scheme changes
2025-03-07 23:10:41 -07:00
const default_light_theme = "{{ default_theme }}";
const default_dark_theme = "{{ preferred_dark_theme }}";
Remove direct search index reference from searcher Because `{{resource}}` references don't affect the hash[^1], we need to avoid referencing dynamic content from within static content. Otherwise, you get a cached searcher.js referencing a searchindex that no longer exists. [^1]: if we made it affect the hash, we'd have to do full dependency tracking, and we'd no longer be able to support circular refs
2025-07-07 08:46:52 -07:00
{{#if search_js}}
window.path_to_searchindex_js = "{{ resource "searchindex.js" }}";
{{/if}}
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
</script>
Fix inadvertently broken folding behavior
2024-11-06 14:56:49 -07:00
<!-- Start loading toc.js asap -->
feat(html): cache bust static files by adding hashes to file names Closes rust-lang#1254
2025-02-13 10:04:21 -07:00
<script src="{{ resource "toc.js" }}"></script>
Fix inadvertently broken folding behavior
2024-11-06 14:56:49 -07:00
</head>
<body>
Some updates to the help popup This makes a few changes to the help popup: - Move css to chrome.css, since this is a UI element. - Move HTML code to index.hbs instead of generated in JavaScript. In general I prefer to keep HTML out of JavaScript when possible, and I didn't see a particular reason to avoid it. - Added a click handler to dismiss the popup. - Make sure handlers get removed when dismissed. - Use `mdbook-` prefixes for IDs to avoid collisions with headers. - Don't show search if it isn't enabled. - Add the new `/` shortcut. - Use flex layout for better positioning. - Dim out the surrounding text using an overlay. - Various other styling tweaks. - Add a GUI test.
2025-05-14 18:17:16 -07:00
<div id="mdbook-help-container">
<div id="mdbook-help-popup">
<h2 class="mdbook-help-title">Keyboard shortcuts</h2>
<div>
<p>Press <kbd>←</kbd> or <kbd>→</kbd> to navigate between chapters</p>
{{#if search_enabled}}
<p>Press <kbd>S</kbd> or <kbd>/</kbd> to search in the book</p>
{{/if}}
<p>Press <kbd>?</kbd> to show this help</p>
<p>Press <kbd>Esc</kbd> to hide this help</p>
</div>
</div>
</div>
Change all HTML IDs to have a prefix This changes all HTML IDs so that they have the `mdbook-` prefix. This should help avoid ID conflicts between internal IDs and IDs from user content such as section headers. This is a relatively disruptive change and has a high risk of breaking something. However, I think I have covered everything, and if anything is missed, hopefully it will get detected. I did not change class names since the chance of a collision is much smaller than with IDs. However, that is something that could be considered in the future. Closes https://github.com/rust-lang/mdBook/issues/880
2025-08-19 19:38:22 -07:00
<div id="mdbook-body-container">
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
<!-- Work around some values being stored in localStorage wrapped in quotes -->
Remove unneeded type attribute for <script>
2022-08-29 21:07:50 +02:00
<script>
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
try {
Fix eslint warnings
2025-02-21 22:55:23 +01:00
let theme = localStorage.getItem('mdbook-theme');
let sidebar = localStorage.getItem('mdbook-sidebar');
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
if (theme.startsWith('"') && theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
}
} catch (e) { }
</script>
<!-- Set the theme before any content is loaded, prevents flash -->
Remove unneeded type attribute for <script>
2022-08-29 21:07:50 +02:00
<script>
Switch theme when preferred color scheme changes
2025-03-07 23:10:41 -07:00
const default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? default_dark_theme : default_light_theme;
Fix eslint warnings
2025-02-21 22:55:23 +01:00
let theme;
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
Improve theme support when JS is disabled
2024-10-23 18:16:52 +02:00
const html = document.documentElement;
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
html.classList.remove('{{ default_theme }}')
html.classList.add(theme);
Improve theme support when JS is disabled
2024-10-23 18:16:52 +02:00
html.classList.add("js");
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
</script>
Change all HTML IDs to have a prefix This changes all HTML IDs so that they have the `mdbook-` prefix. This should help avoid ID conflicts between internal IDs and IDs from user content such as section headers. This is a relatively disruptive change and has a high risk of breaking something. However, I think I have covered everything, and if anything is missed, hopefully it will get detected. I did not change class names since the chance of a collision is much smaller than with IDs. However, that is something that could be considered in the future. Closes https://github.com/rust-lang/mdBook/issues/880
2025-08-19 19:38:22 -07:00
<input type="checkbox" id="mdbook-sidebar-toggle-anchor" class="hidden">
Sidebar but Pure CSS, fix rust-lang/mdBook#859 * change sidebar-toggle button by input:checked and label * change nav-wrappers' CSS selectors * remove loading animation when page opens with z-index
2023-08-24 16:44:25 +08:00
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
<!-- Hide / unhide sidebar before it is displayed -->
Remove unneeded type attribute for <script>
2022-08-29 21:07:50 +02:00
<script>
Fix eslint warnings
2025-02-21 22:55:23 +01:00
let sidebar = null;
Change all HTML IDs to have a prefix This changes all HTML IDs so that they have the `mdbook-` prefix. This should help avoid ID conflicts between internal IDs and IDs from user content such as section headers. This is a relatively disruptive change and has a high risk of breaking something. However, I think I have covered everything, and if anything is missed, hopefully it will get detected. I did not change class names since the chance of a collision is much smaller than with IDs. However, that is something that could be considered in the future. Closes https://github.com/rust-lang/mdBook/issues/880
2025-08-19 19:38:22 -07:00
const sidebar_toggle = document.getElementById("mdbook-sidebar-toggle-anchor");
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
Default the sidebar to visible in large screens The code here leads me to believe that the intention is for the sidebar to be default visible on large screens (where `clientWidth` > 1080) and hidden otherwise. However, as previously written, if the `localStorage.getItem` call fails (for example, if the user agent is not accepting cookies), then we fall back to `sidebar = sidebar || 'visible';` — but `sidebar` is already set to `hidden`, so the `|| 'visible'` never happens. This results in the sidebar hiding itself on every navigation through an mdBook, meaning if you're just switching between sections trying to find something that you keep needing to re-open the sidebar.
2023-02-11 18:04:58 -05:00
} else {
sidebar = 'hidden';
Hide the sidebar when collapsed to prevent browser search to find text from it
2025-06-05 16:27:47 +02:00
sidebar_toggle.checked = false;
}
if (sidebar === 'visible') {
sidebar_toggle.checked = true;
} else {
html.classList.remove('sidebar-visible');
Allow to define own HTML <head> attributes Create a `index.hbs` template file to render additional HTML <head> attributes
2020-05-01 07:47:50 +02:00
}
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
</script>
Started to clean the 'previous' and 'next' handlebars helpers #26 But got stuck, waiting for a response
2015-08-03 22:09:26 +02:00
Change all HTML IDs to have a prefix This changes all HTML IDs so that they have the `mdbook-` prefix. This should help avoid ID conflicts between internal IDs and IDs from user content such as section headers. This is a relatively disruptive change and has a high risk of breaking something. However, I think I have covered everything, and if anything is missed, hopefully it will get detected. I did not change class names since the chance of a collision is much smaller than with IDs. However, that is something that could be considered in the future. Closes https://github.com/rust-lang/mdBook/issues/880
2025-08-19 19:38:22 -07:00
<nav id="mdbook-sidebar" class="sidebar" aria-label="Table of contents">
Load the sidebar toc from a shared JS file 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.
2024-07-15 18:38:50 -07:00
<!-- populated by js -->
Fix inadvertently broken folding behavior
2024-11-06 14:56:49 -07:00
<mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
Make the sidebar work without JS 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.
2024-07-16 12:23:26 -07:00
<noscript>
Fix, and test, the no-js toc sidebar with hashed resources To make this work, I need to break the circular dependency and stop hashing toc.html itself.
2025-02-20 10:25:51 -07:00
<iframe class="sidebar-iframe-outer" src="{{ path_to_root }}toc.html"></iframe>
Make the sidebar work without JS 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.
2024-07-16 12:23:26 -07:00
</noscript>
Change all HTML IDs to have a prefix This changes all HTML IDs so that they have the `mdbook-` prefix. This should help avoid ID conflicts between internal IDs and IDs from user content such as section headers. This is a relatively disruptive change and has a high risk of breaking something. However, I think I have covered everything, and if anything is missed, hopefully it will get detected. I did not change class names since the chance of a collision is much smaller than with IDs. However, that is something that could be considered in the future. Closes https://github.com/rust-lang/mdBook/issues/880
2025-08-19 19:38:22 -07:00
<div id="mdbook-sidebar-resize-handle" class="sidebar-resize-handle">
feat(sidebar): add sidebar indicator
2023-10-02 18:24:55 +03:00
<div class="sidebar-resize-indicator"></div>
</div>
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
</nav>
Allow to define own HTML <head> attributes Create a `index.hbs` template file to render additional HTML <head> attributes
2020-05-01 07:47:50 +02:00
Change all HTML IDs to have a prefix This changes all HTML IDs so that they have the `mdbook-` prefix. This should help avoid ID conflicts between internal IDs and IDs from user content such as section headers. This is a relatively disruptive change and has a high risk of breaking something. However, I think I have covered everything, and if anything is missed, hopefully it will get detected. I did not change class names since the chance of a collision is much smaller than with IDs. However, that is something that could be considered in the future. Closes https://github.com/rust-lang/mdBook/issues/880
2025-08-19 19:38:22 -07:00
<div id="mdbook-page-wrapper" class="page-wrapper">
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
<div class="page">
{{> header}}
Change all HTML IDs to have a prefix This changes all HTML IDs so that they have the `mdbook-` prefix. This should help avoid ID conflicts between internal IDs and IDs from user content such as section headers. This is a relatively disruptive change and has a high risk of breaking something. However, I think I have covered everything, and if anything is missed, hopefully it will get detected. I did not change class names since the chance of a collision is much smaller than with IDs. However, that is something that could be considered in the future. Closes https://github.com/rust-lang/mdBook/issues/880
2025-08-19 19:38:22 -07:00
<div id="mdbook-menu-bar-hover-placeholder"></div>
<div id="mdbook-menu-bar" class="menu-bar sticky">
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
<div class="left-buttons">
Change all HTML IDs to have a prefix This changes all HTML IDs so that they have the `mdbook-` prefix. This should help avoid ID conflicts between internal IDs and IDs from user content such as section headers. This is a relatively disruptive change and has a high risk of breaking something. However, I think I have covered everything, and if anything is missed, hopefully it will get detected. I did not change class names since the chance of a collision is much smaller than with IDs. However, that is something that could be considered in the future. Closes https://github.com/rust-lang/mdBook/issues/880
2025-08-19 19:38:22 -07:00
<label id="mdbook-sidebar-toggle" class="icon-button" for="mdbook-sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="mdbook-sidebar">
Use embedded SVG instead of fonts for icons The [downsides of icon fonts] are well-documented, and also, why ship all of the icons when it only uses 14? [downsides of icon fonts]: https://speakerdeck.com/ninjanails/death-to-icon-fonts
2024-06-08 14:19:48 -07:00
{{fa "solid" "bars"}}
Sidebar but Pure CSS, fix rust-lang/mdBook#859 * change sidebar-toggle button by input:checked and label * change nav-wrappers' CSS selectors * remove loading animation when page opens with z-index
2023-08-24 16:44:25 +08:00
</label>
Change all HTML IDs to have a prefix This changes all HTML IDs so that they have the `mdbook-` prefix. This should help avoid ID conflicts between internal IDs and IDs from user content such as section headers. This is a relatively disruptive change and has a high risk of breaking something. However, I think I have covered everything, and if anything is missed, hopefully it will get detected. I did not change class names since the chance of a collision is much smaller than with IDs. However, that is something that could be considered in the future. Closes https://github.com/rust-lang/mdBook/issues/880
2025-08-19 19:38:22 -07:00
<button id="mdbook-theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="mdbook-theme-list">
Use embedded SVG instead of fonts for icons The [downsides of icon fonts] are well-documented, and also, why ship all of the icons when it only uses 14? [downsides of icon fonts]: https://speakerdeck.com/ninjanails/death-to-icon-fonts
2024-06-08 14:19:48 -07:00
{{fa "solid" "paintbrush"}}
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
</button>
Change all HTML IDs to have a prefix This changes all HTML IDs so that they have the `mdbook-` prefix. This should help avoid ID conflicts between internal IDs and IDs from user content such as section headers. This is a relatively disruptive change and has a high risk of breaking something. However, I think I have covered everything, and if anything is missed, hopefully it will get detected. I did not change class names since the chance of a collision is much smaller than with IDs. However, that is something that could be considered in the future. Closes https://github.com/rust-lang/mdBook/issues/880
2025-08-19 19:38:22 -07:00
<ul id="mdbook-theme-list" class="theme-popup" aria-label="Themes" role="menu">
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-default_theme">Auto</button></li>
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-light">Light</button></li>
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-rust">Rust</button></li>
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-coal">Coal</button></li>
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-navy">Navy</button></li>
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-ayu">Ayu</button></li>
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
</ul>
{{#if search_enabled}}
Change all HTML IDs to have a prefix This changes all HTML IDs so that they have the `mdbook-` prefix. This should help avoid ID conflicts between internal IDs and IDs from user content such as section headers. This is a relatively disruptive change and has a high risk of breaking something. However, I think I have covered everything, and if anything is missed, hopefully it will get detected. I did not change class names since the chance of a collision is much smaller than with IDs. However, that is something that could be considered in the future. Closes https://github.com/rust-lang/mdBook/issues/880
2025-08-19 19:38:22 -07:00
<button id="mdbook-search-toggle" class="icon-button" type="button" title="Search (`/`)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="/ s" aria-controls="mdbook-searchbar">
Use embedded SVG instead of fonts for icons The [downsides of icon fonts] are well-documented, and also, why ship all of the icons when it only uses 14? [downsides of icon fonts]: https://speakerdeck.com/ninjanails/death-to-icon-fonts
2024-06-08 14:19:48 -07:00
{{fa "solid" "magnifying-glass"}}
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
</button>
{{/if}}
</div>
<h1 class="menu-title">{{ book_title }}</h1>
<div class="right-buttons">
Add config option to disable print html, css, and icon
2020-03-30 10:38:37 +02:00
{{#if print_enable}}
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
<a href="{{ path_to_root }}print.html" title="Print this book" aria-label="Print this book">
Use embedded SVG instead of fonts for icons The [downsides of icon fonts] are well-documented, and also, why ship all of the icons when it only uses 14? [downsides of icon fonts]: https://speakerdeck.com/ninjanails/death-to-icon-fonts
2024-06-08 14:19:48 -07:00
{{fa "solid" "print" "print-button"}}
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
</a>
Add config option to disable print html, css, and icon
2020-03-30 10:38:37 +02:00
{{/if}}
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
{{#if git_repository_url}}
<a href="{{git_repository_url}}" title="Git repository" aria-label="Git repository">
Use embedded SVG instead of fonts for icons The [downsides of icon fonts] are well-documented, and also, why ship all of the icons when it only uses 14? [downsides of icon fonts]: https://speakerdeck.com/ninjanails/death-to-icon-fonts
2024-06-08 14:19:48 -07:00
{{fa git_repository_icon_class git_repository_icon}}
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
</a>
{{/if}}
[ReviewFix] Replace edit baseurl with template and make visibility independent of git_repository_url.
2020-02-18 00:41:03 +02:00
{{#if git_repository_edit_url}}
Add rel="edit" for the edit button rel=edit lets a page indicate that the linked resource can be used to edit the page. It is defined at https://microformats.org/wiki/rel-edit. This can then be parsed by tools like the Universal Edit Button and custom bookmarklets to open the edit page corresponding with a website.
2025-05-14 22:57:58 +01:00
<a href="{{git_repository_edit_url}}" title="Suggest an edit" aria-label="Suggest an edit" rel="edit">
Use embedded SVG instead of fonts for icons The [downsides of icon fonts] are well-documented, and also, why ship all of the icons when it only uses 14? [downsides of icon fonts]: https://speakerdeck.com/ninjanails/death-to-icon-fonts
2024-06-08 14:19:48 -07:00
{{fa "solid" "pencil" "git-edit-button"}}
Add "Suggest an edit" link next to "Git repository" Includes new configuration option `git-repository-edit-baseurl` for supporting non-GitHub repository layouts.
2020-02-17 22:59:37 +02:00
</a>
{{/if}}
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
</div>
Optimized the stylesheet for better performance
2017-12-06 16:20:22 +08:00
</div>
Tweaks to the docs + clean-up
2015-08-06 15:24:34 +02:00
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
{{#if search_enabled}}
Change all HTML IDs to have a prefix This changes all HTML IDs so that they have the `mdbook-` prefix. This should help avoid ID conflicts between internal IDs and IDs from user content such as section headers. This is a relatively disruptive change and has a high risk of breaking something. However, I think I have covered everything, and if anything is missed, hopefully it will get detected. I did not change class names since the chance of a collision is much smaller than with IDs. However, that is something that could be considered in the future. Closes https://github.com/rust-lang/mdBook/issues/880
2025-08-19 19:38:22 -07:00
<div id="mdbook-search-wrapper" class="hidden">
<form id="mdbook-searchbar-outer" class="searchbar-outer">
Add a spinner when search is in progress
2025-02-21 14:25:58 +01:00
<div class="search-wrapper">
Change all HTML IDs to have a prefix This changes all HTML IDs so that they have the `mdbook-` prefix. This should help avoid ID conflicts between internal IDs and IDs from user content such as section headers. This is a relatively disruptive change and has a high risk of breaking something. However, I think I have covered everything, and if anything is missed, hopefully it will get detected. I did not change class names since the chance of a collision is much smaller than with IDs. However, that is something that could be considered in the future. Closes https://github.com/rust-lang/mdBook/issues/880
2025-08-19 19:38:22 -07:00
<input type="search" id="mdbook-searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="mdbook-searchresults-outer" aria-describedby="searchresults-header">
Add a spinner when search is in progress
2025-02-21 14:25:58 +01:00
<div class="spinner-wrapper">
Use embedded SVG instead of fonts for icons The [downsides of icon fonts] are well-documented, and also, why ship all of the icons when it only uses 14? [downsides of icon fonts]: https://speakerdeck.com/ninjanails/death-to-icon-fonts
2024-06-08 14:19:48 -07:00
{{fa "solid" "spinner" "fa-spin"}}
Add a spinner when search is in progress
2025-02-21 14:25:58 +01:00
</div>
</div>
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
</form>
Change all HTML IDs to have a prefix This changes all HTML IDs so that they have the `mdbook-` prefix. This should help avoid ID conflicts between internal IDs and IDs from user content such as section headers. This is a relatively disruptive change and has a high risk of breaking something. However, I think I have covered everything, and if anything is missed, hopefully it will get detected. I did not change class names since the chance of a collision is much smaller than with IDs. However, that is something that could be considered in the future. Closes https://github.com/rust-lang/mdBook/issues/880
2025-08-19 19:38:22 -07:00
<div id="mdbook-searchresults-outer" class="searchresults-outer hidden">
<div id="mdbook-searchresults-header" class="searchresults-header"></div>
<ul id="mdbook-searchresults">
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
</ul>
</div>
</div>
{{/if}}
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
Remove unneeded type attribute for <script>
2022-08-29 21:07:50 +02:00
<script>
Change all HTML IDs to have a prefix This changes all HTML IDs so that they have the `mdbook-` prefix. This should help avoid ID conflicts between internal IDs and IDs from user content such as section headers. This is a relatively disruptive change and has a high risk of breaking something. However, I think I have covered everything, and if anything is missed, hopefully it will get detected. I did not change class names since the chance of a collision is much smaller than with IDs. However, that is something that could be considered in the future. Closes https://github.com/rust-lang/mdBook/issues/880
2025-08-19 19:38:22 -07:00
document.getElementById('mdbook-sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('mdbook-sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#mdbook-sidebar a')).forEach(function(link) {
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
</script>
Change all HTML IDs to have a prefix This changes all HTML IDs so that they have the `mdbook-` prefix. This should help avoid ID conflicts between internal IDs and IDs from user content such as section headers. This is a relatively disruptive change and has a high risk of breaking something. However, I think I have covered everything, and if anything is missed, hopefully it will get detected. I did not change class names since the chance of a collision is much smaller than with IDs. However, that is something that could be considered in the future. Closes https://github.com/rust-lang/mdBook/issues/880
2025-08-19 19:38:22 -07:00
<div id="mdbook-content" class="content">
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
<main>
{{{ content }}}
</main>
<nav class="nav-wrapper" aria-label="Page navigation">
<!-- Mobile navigation buttons -->
Replace navigation helpers with objects This replaces the `{{#previous}}` and `{{#next}}` handelbars helpers with simple objects that contain the previous and next values. These helpers have been a bit fussy to work with and have caused issues in the past. This drops a large amount of somewhat fragile code with something that is a bit simpler. Additionally, this switches the previous/next arrows to use an `{{#if}}` instead CSS trickery which may help with upcoming changes to font-awesome.
2025-08-13 17:56:11 -07:00
{{#if previous}}
<a rel="prev" href="{{ path_to_root }}{{previous.link}}" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
{{#if (eq ../text_direction "rtl")}}
Use embedded SVG instead of fonts for icons The [downsides of icon fonts] are well-documented, and also, why ship all of the icons when it only uses 14? [downsides of icon fonts]: https://speakerdeck.com/ninjanails/death-to-icon-fonts
2024-06-08 14:19:48 -07:00
{{fa "solid" "angle-right"}}
Replace navigation helpers with objects This replaces the `{{#previous}}` and `{{#next}}` handelbars helpers with simple objects that contain the previous and next values. These helpers have been a bit fussy to work with and have caused issues in the past. This drops a large amount of somewhat fragile code with something that is a bit simpler. Additionally, this switches the previous/next arrows to use an `{{#if}}` instead CSS trickery which may help with upcoming changes to font-awesome.
2025-08-13 17:56:11 -07:00
{{else}}
Use embedded SVG instead of fonts for icons The [downsides of icon fonts] are well-documented, and also, why ship all of the icons when it only uses 14? [downsides of icon fonts]: https://speakerdeck.com/ninjanails/death-to-icon-fonts
2024-06-08 14:19:48 -07:00
{{fa "solid" "angle-left"}}
Replace navigation helpers with objects This replaces the `{{#previous}}` and `{{#next}}` handelbars helpers with simple objects that contain the previous and next values. These helpers have been a bit fussy to work with and have caused issues in the past. This drops a large amount of somewhat fragile code with something that is a bit simpler. Additionally, this switches the previous/next arrows to use an `{{#if}}` instead CSS trickery which may help with upcoming changes to font-awesome.
2025-08-13 17:56:11 -07:00
{{/if}}
Fix broken a tag This fixes the missing close `</a>` tag for the "previous" button.
2025-09-15 20:17:11 -07:00
</a>
Replace navigation helpers with objects This replaces the `{{#previous}}` and `{{#next}}` handelbars helpers with simple objects that contain the previous and next values. These helpers have been a bit fussy to work with and have caused issues in the past. This drops a large amount of somewhat fragile code with something that is a bit simpler. Additionally, this switches the previous/next arrows to use an `{{#if}}` instead CSS trickery which may help with upcoming changes to font-awesome.
2025-08-13 17:56:11 -07:00
{{/if}}
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
Replace navigation helpers with objects This replaces the `{{#previous}}` and `{{#next}}` handelbars helpers with simple objects that contain the previous and next values. These helpers have been a bit fussy to work with and have caused issues in the past. This drops a large amount of somewhat fragile code with something that is a bit simpler. Additionally, this switches the previous/next arrows to use an `{{#if}}` instead CSS trickery which may help with upcoming changes to font-awesome.
2025-08-13 17:56:11 -07:00
{{#if next}}
<a rel="next prefetch" href="{{ path_to_root }}{{next.link}}" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
{{#if (eq ../text_direction "rtl")}}
Use embedded SVG instead of fonts for icons The [downsides of icon fonts] are well-documented, and also, why ship all of the icons when it only uses 14? [downsides of icon fonts]: https://speakerdeck.com/ninjanails/death-to-icon-fonts
2024-06-08 14:19:48 -07:00
{{fa "solid" "angle-left"}}
Replace navigation helpers with objects This replaces the `{{#previous}}` and `{{#next}}` handelbars helpers with simple objects that contain the previous and next values. These helpers have been a bit fussy to work with and have caused issues in the past. This drops a large amount of somewhat fragile code with something that is a bit simpler. Additionally, this switches the previous/next arrows to use an `{{#if}}` instead CSS trickery which may help with upcoming changes to font-awesome.
2025-08-13 17:56:11 -07:00
{{else}}
Use embedded SVG instead of fonts for icons The [downsides of icon fonts] are well-documented, and also, why ship all of the icons when it only uses 14? [downsides of icon fonts]: https://speakerdeck.com/ninjanails/death-to-icon-fonts
2024-06-08 14:19:48 -07:00
{{fa "solid" "angle-right"}}
Replace navigation helpers with objects This replaces the `{{#previous}}` and `{{#next}}` handelbars helpers with simple objects that contain the previous and next values. These helpers have been a bit fussy to work with and have caused issues in the past. This drops a large amount of somewhat fragile code with something that is a bit simpler. Additionally, this switches the previous/next arrows to use an `{{#if}}` instead CSS trickery which may help with upcoming changes to font-awesome.
2025-08-13 17:56:11 -07:00
{{/if}}
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
</a>
Replace navigation helpers with objects This replaces the `{{#previous}}` and `{{#next}}` handelbars helpers with simple objects that contain the previous and next values. These helpers have been a bit fussy to work with and have caused issues in the past. This drops a large amount of somewhat fragile code with something that is a bit simpler. Additionally, this switches the previous/next arrows to use an `{{#if}}` instead CSS trickery which may help with upcoming changes to font-awesome.
2025-08-13 17:56:11 -07:00
{{/if}}
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
<div style="clear: both"></div>
</nav>
Allow to define own HTML <head> attributes Create a `index.hbs` template file to render additional HTML <head> attributes
2020-05-01 07:47:50 +02:00
</div>
</div>
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
<nav class="nav-wide-wrapper" aria-label="Page navigation">
Replace navigation helpers with objects This replaces the `{{#previous}}` and `{{#next}}` handelbars helpers with simple objects that contain the previous and next values. These helpers have been a bit fussy to work with and have caused issues in the past. This drops a large amount of somewhat fragile code with something that is a bit simpler. Additionally, this switches the previous/next arrows to use an `{{#if}}` instead CSS trickery which may help with upcoming changes to font-awesome.
2025-08-13 17:56:11 -07:00
{{#if previous}}
<a rel="prev" href="{{ path_to_root }}{{previous.link}}" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
{{#if (eq ../text_direction "rtl")}}
Use embedded SVG instead of fonts for icons The [downsides of icon fonts] are well-documented, and also, why ship all of the icons when it only uses 14? [downsides of icon fonts]: https://speakerdeck.com/ninjanails/death-to-icon-fonts
2024-06-08 14:19:48 -07:00
{{fa "solid" "angle-right"}}
Replace navigation helpers with objects This replaces the `{{#previous}}` and `{{#next}}` handelbars helpers with simple objects that contain the previous and next values. These helpers have been a bit fussy to work with and have caused issues in the past. This drops a large amount of somewhat fragile code with something that is a bit simpler. Additionally, this switches the previous/next arrows to use an `{{#if}}` instead CSS trickery which may help with upcoming changes to font-awesome.
2025-08-13 17:56:11 -07:00
{{else}}
Use embedded SVG instead of fonts for icons The [downsides of icon fonts] are well-documented, and also, why ship all of the icons when it only uses 14? [downsides of icon fonts]: https://speakerdeck.com/ninjanails/death-to-icon-fonts
2024-06-08 14:19:48 -07:00
{{fa "solid" "angle-left"}}
Replace navigation helpers with objects This replaces the `{{#previous}}` and `{{#next}}` handelbars helpers with simple objects that contain the previous and next values. These helpers have been a bit fussy to work with and have caused issues in the past. This drops a large amount of somewhat fragile code with something that is a bit simpler. Additionally, this switches the previous/next arrows to use an `{{#if}}` instead CSS trickery which may help with upcoming changes to font-awesome.
2025-08-13 17:56:11 -07:00
{{/if}}
Improve accessibility (#535) * fix(theme/index): Use nav element for Table of Content * fix(renderer/html_handlebars/helpers/toc): Use ol instead of ul Chapters and sections are ordered, so we should use the appropriate HTML tag. * fix(renderer/html_handlebars/helpers/toc): Hide section number from screen readers Screen readers have this functionality build-in, no need to present this. Ideally, this should not even be in the DOM tree, since the numbers can be shown by using CSS. * fix(theme/index): Remove tabIndex="-1" from .page Divs are not focusable by default * fix(theme): Make sidebar accessible Using aria-hidden (together with tabIndex) takes the links out of the tab order. http://heydonworks.com/practical_aria_examples/#progressive-collapsibles * fix(theme/index): Wrap content inside main tag The main tag helps users skip additional content on the page. * fix(theme/book): Don't focus .page on page load The main content is identified by the main tag, not by auto-focusing it on page load. * fix(theme/index): Make page controls accessible * fix: Make theme selector accessible - Use ul and li (since it is a list) - Add aria-expanded and aria-haspopup to the toggle button - Use button instead of div (buttons are accessible by default) - Handle Esc key (close popup) - Adjust CSS to keep same visual style * fix(theme/stylus/sidebar): Make link clickable area wider Links now expand to fill the entire row. * fix(theme): Wrap header buttons and improve animation performance Previously, the header had a fixed height, which meant that sometimes the print button was not visible. Animating the left property is expensive, which lead to laggy animations - transform is much cheaper and has the same effect. * fix(theme/stylus/theme-popup): Theme button inherits color Bug introduced while making the popup accessible * fix(theme/book): Handle edge case when toggling sidebar Bug introduced when switching from animating left to using transform.
2018-01-15 14:26:53 +01:00
</a>
Replace navigation helpers with objects This replaces the `{{#previous}}` and `{{#next}}` handelbars helpers with simple objects that contain the previous and next values. These helpers have been a bit fussy to work with and have caused issues in the past. This drops a large amount of somewhat fragile code with something that is a bit simpler. Additionally, this switches the previous/next arrows to use an `{{#if}}` instead CSS trickery which may help with upcoming changes to font-awesome.
2025-08-13 17:56:11 -07:00
{{/if}}
Improve accessibility (#535) * fix(theme/index): Use nav element for Table of Content * fix(renderer/html_handlebars/helpers/toc): Use ol instead of ul Chapters and sections are ordered, so we should use the appropriate HTML tag. * fix(renderer/html_handlebars/helpers/toc): Hide section number from screen readers Screen readers have this functionality build-in, no need to present this. Ideally, this should not even be in the DOM tree, since the numbers can be shown by using CSS. * fix(theme/index): Remove tabIndex="-1" from .page Divs are not focusable by default * fix(theme): Make sidebar accessible Using aria-hidden (together with tabIndex) takes the links out of the tab order. http://heydonworks.com/practical_aria_examples/#progressive-collapsibles * fix(theme/index): Wrap content inside main tag The main tag helps users skip additional content on the page. * fix(theme/book): Don't focus .page on page load The main content is identified by the main tag, not by auto-focusing it on page load. * fix(theme/index): Make page controls accessible * fix: Make theme selector accessible - Use ul and li (since it is a list) - Add aria-expanded and aria-haspopup to the toggle button - Use button instead of div (buttons are accessible by default) - Handle Esc key (close popup) - Adjust CSS to keep same visual style * fix(theme/stylus/sidebar): Make link clickable area wider Links now expand to fill the entire row. * fix(theme): Wrap header buttons and improve animation performance Previously, the header had a fixed height, which meant that sometimes the print button was not visible. Animating the left property is expensive, which lead to laggy animations - transform is much cheaper and has the same effect. * fix(theme/stylus/theme-popup): Theme button inherits color Bug introduced while making the popup accessible * fix(theme/book): Handle edge case when toggling sidebar Bug introduced when switching from animating left to using transform.
2018-01-15 14:26:53 +01:00
Replace navigation helpers with objects This replaces the `{{#previous}}` and `{{#next}}` handelbars helpers with simple objects that contain the previous and next values. These helpers have been a bit fussy to work with and have caused issues in the past. This drops a large amount of somewhat fragile code with something that is a bit simpler. Additionally, this switches the previous/next arrows to use an `{{#if}}` instead CSS trickery which may help with upcoming changes to font-awesome.
2025-08-13 17:56:11 -07:00
{{#if next}}
<a rel="next prefetch" href="{{ path_to_root }}{{next.link}}" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
{{#if (eq text_direction "rtl")}}
Use embedded SVG instead of fonts for icons The [downsides of icon fonts] are well-documented, and also, why ship all of the icons when it only uses 14? [downsides of icon fonts]: https://speakerdeck.com/ninjanails/death-to-icon-fonts
2024-06-08 14:19:48 -07:00
{{fa "solid" "angle-left"}}
Replace navigation helpers with objects This replaces the `{{#previous}}` and `{{#next}}` handelbars helpers with simple objects that contain the previous and next values. These helpers have been a bit fussy to work with and have caused issues in the past. This drops a large amount of somewhat fragile code with something that is a bit simpler. Additionally, this switches the previous/next arrows to use an `{{#if}}` instead CSS trickery which may help with upcoming changes to font-awesome.
2025-08-13 17:56:11 -07:00
{{else}}
Use embedded SVG instead of fonts for icons The [downsides of icon fonts] are well-documented, and also, why ship all of the icons when it only uses 14? [downsides of icon fonts]: https://speakerdeck.com/ninjanails/death-to-icon-fonts
2024-06-08 14:19:48 -07:00
{{fa "solid" "angle-right"}}
Replace navigation helpers with objects This replaces the `{{#previous}}` and `{{#next}}` handelbars helpers with simple objects that contain the previous and next values. These helpers have been a bit fussy to work with and have caused issues in the past. This drops a large amount of somewhat fragile code with something that is a bit simpler. Additionally, this switches the previous/next arrows to use an `{{#if}}` instead CSS trickery which may help with upcoming changes to font-awesome.
2025-08-13 17:56:11 -07:00
{{/if}}
Improve accessibility (#535) * fix(theme/index): Use nav element for Table of Content * fix(renderer/html_handlebars/helpers/toc): Use ol instead of ul Chapters and sections are ordered, so we should use the appropriate HTML tag. * fix(renderer/html_handlebars/helpers/toc): Hide section number from screen readers Screen readers have this functionality build-in, no need to present this. Ideally, this should not even be in the DOM tree, since the numbers can be shown by using CSS. * fix(theme/index): Remove tabIndex="-1" from .page Divs are not focusable by default * fix(theme): Make sidebar accessible Using aria-hidden (together with tabIndex) takes the links out of the tab order. http://heydonworks.com/practical_aria_examples/#progressive-collapsibles * fix(theme/index): Wrap content inside main tag The main tag helps users skip additional content on the page. * fix(theme/book): Don't focus .page on page load The main content is identified by the main tag, not by auto-focusing it on page load. * fix(theme/index): Make page controls accessible * fix: Make theme selector accessible - Use ul and li (since it is a list) - Add aria-expanded and aria-haspopup to the toggle button - Use button instead of div (buttons are accessible by default) - Handle Esc key (close popup) - Adjust CSS to keep same visual style * fix(theme/stylus/sidebar): Make link clickable area wider Links now expand to fill the entire row. * fix(theme): Wrap header buttons and improve animation performance Previously, the header had a fixed height, which meant that sometimes the print button was not visible. Animating the left property is expensive, which lead to laggy animations - transform is much cheaper and has the same effect. * fix(theme/stylus/theme-popup): Theme button inherits color Bug introduced while making the popup accessible * fix(theme/book): Handle edge case when toggling sidebar Bug introduced when switching from animating left to using transform.
2018-01-15 14:26:53 +01:00
</a>
Replace navigation helpers with objects This replaces the `{{#previous}}` and `{{#next}}` handelbars helpers with simple objects that contain the previous and next values. These helpers have been a bit fussy to work with and have caused issues in the past. This drops a large amount of somewhat fragile code with something that is a bit simpler. Additionally, this switches the previous/next arrows to use an `{{#if}}` instead CSS trickery which may help with upcoming changes to font-awesome.
2025-08-13 17:56:11 -07:00
{{/if}}
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
</nav>
Added navigation icons + javascript code to hide them when there is no previous or next. Closes #12
2015-08-01 14:12:55 +02:00
added markdown with 'pulldown-cmark', added basic styling, render of the toc is still not completely done
2015-07-28 21:01:13 +02:00
</div>
Split of the creating of the JSon object into it's own function
2015-07-19 14:02:21 +02:00
Use embedded SVG instead of fonts for icons The [downsides of icon fonts] are well-documented, and also, why ship all of the icons when it only uses 14? [downsides of icon fonts]: https://speakerdeck.com/ninjanails/death-to-icon-fonts
2024-06-08 14:19:48 -07:00
<template id=fa-eye>{{fa "solid" "eye"}}</template>
<template id=fa-eye-slash>{{fa "solid" "eye-slash"}}</template>
<template id=fa-copy>{{fa "regular" "copy"}}</template>
<template id=fa-play>{{fa "solid" "play"}}</template>
<template id=fa-clock-rotate-left>{{fa "solid" "clock-rotate-left"}}</template>
livereload uses host&port of current page; livereload works with a HTTPS site
2022-03-19 04:38:16 +08:00
{{#if live_reload_endpoint}}
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
<!-- Livereload script (if served using the cli tool) -->
Remove unneeded type attribute for <script>
2022-08-29 21:07:50 +02:00
<script>
livereload uses host&port of current page; livereload works with a HTTPS site
2022-03-19 04:38:16 +08:00
const wsProtocol = location.protocol === 'https:' ? 'wss:' : 'ws:';
const wsAddress = wsProtocol + "//" + location.host + "/" + "{{{live_reload_endpoint}}}";
const socket = new WebSocket(wsAddress);
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
socket.onmessage = function (event) {
if (event.data === "reload") {
socket.close();
location.reload();
}
};
window.onbeforeunload = function() {
Add support for alternative backends (#507) * Added a mechanism for creating alternate backends * Added a CmdRenderer and the ability to have multiple renderers * Made MDBook::load() autodetect renderers * Added a couple methods to RenderContext * Converted RenderContext.version to a String * Made sure all alternate renderers are invoked as `mdbook-*` * Factored out the logic for determining which renderer to use * Added tests for renderer detection * Made it so `mdbook test` works on the book-example again * Updated the "For Developers" docs * Removed `[output.epub]` from the example book's book.toml * Added a bit more info on how backends should work * Added a `destination` key to the RenderContext * Altered how we wait for an alternate backend to finish * Refactored the Renderer trait to not use MDBook and moved livereload to the template * Moved info for developers out of the book.toml format chapter * MOAR docs * MDBook::build() no longer takes &mut self * Replaced a bunch of println!()'s with proper log macros * Cleaned up the build() method and backend discovery * Added a couple notes and doc-comments * Found a race condition when backends exit really quickly * Added support for backends with arguments * Fixed a funny doc-comment
2018-01-07 22:10:48 +08:00
socket.close();
}
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
</script>
{{/if}}
Rename playpen to playground. (#1241) looks good
2020-06-22 07:34:25 -07:00
{{#if playground_line_numbers}}
Remove unneeded type attribute for <script>
2022-08-29 21:07:50 +02:00
<script>
Rename playpen to playground. (#1241) looks good
2020-06-22 07:34:25 -07:00
window.playground_line_numbers = true;
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
</script>
{{/if}}
Rename playpen to playground. (#1241) looks good
2020-06-22 07:34:25 -07:00
{{#if playground_copyable}}
Remove unneeded type attribute for <script>
2022-08-29 21:07:50 +02:00
<script>
Rename playpen to playground. (#1241) looks good
2020-06-22 07:34:25 -07:00
window.playground_copyable = true;
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
</script>
{{/if}}
Rename playpen to playground. (#1241) looks good
2020-06-22 07:34:25 -07:00
{{#if playground_js}}
feat(html): cache bust static files by adding hashes to file names Closes rust-lang#1254
2025-02-13 10:04:21 -07:00
<script src="{{ resource "ace.js" }}"></script>
<script src="{{ resource "mode-rust.js" }}"></script>
Fix loading of mode-rust.js The reason the ACE editor was failing to load the rust syntax highlighting is because the syntax highlighting was being created *after* the editor was created. If the editor is created first, then ACE tries to load `ace/mode/rust`. Since it isn't already defined, it tried to compute the URL and load it manually. However, since the URLs now have a hash in it (via https://github.com/rust-lang/mdBook/pull/1368), it was unable to load. The solution here is to make sure `ace/mode/rust` is defined before creating the editors. Then ACE knows that it can just load the module directly instead of trying to fetch it from the server. Fixes https://github.com/rust-lang/mdBook/issues/2700
2025-05-23 07:19:27 -07:00
<script src="{{ resource "editor.js" }}"></script>
feat(html): cache bust static files by adding hashes to file names Closes rust-lang#1254
2025-02-13 10:04:21 -07:00
<script src="{{ resource "theme-dawn.js" }}"></script>
<script src="{{ resource "theme-tomorrow_night.js" }}"></script>
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
{{/if}}
{{#if search_js}}
feat(html): cache bust static files by adding hashes to file names Closes rust-lang#1254
2025-02-13 10:04:21 -07:00
<script src="{{ resource "elasticlunr.min.js" }}"></script>
<script src="{{ resource "mark.min.js" }}"></script>
<script src="{{ resource "searcher.js" }}"></script>
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
{{/if}}
feat(html): cache bust static files by adding hashes to file names Closes rust-lang#1254
2025-02-13 10:04:21 -07:00
<script src="{{ resource "clipboard.min.js" }}"></script>
<script src="{{ resource "highlight.js" }}"></script>
<script src="{{ resource "book.js" }}"></script>
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
<!-- Custom JS scripts -->
{{#each additional_js}}
feat(html): cache bust static files by adding hashes to file names Closes rust-lang#1254
2025-02-13 10:04:21 -07:00
<script src="{{ resource this}}"></script>
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
{{/each}}
{{#if is_print}}
{{#if mathjax_support}}
Remove unneeded type attribute for <script>
2022-08-29 21:07:50 +02:00
<script>
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
window.addEventListener('load', function() {
MathJax.Hub.Register.StartupHook('End', function() {
Improve print output (#680) * Update print styles for new sidebar behavior * Hide copy icons in print output * Wait for mathjax rendering to complete before printing * Remove old wrapping css Browsers this old are already hilariously broken, so we don't need these fallbacks. * Change mathjax script type Chrome won't execute this if it's not marked as js * Ensure page has rendered before printing In certain situations Chrome willl fire window.onLoad before it's done rendering. Add a 100ms delay to work around this.
2018-05-01 07:29:34 -05:00
window.setTimeout(window.print, 100);
});
});
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
</script>
{{else}}
Remove unneeded type attribute for <script>
2022-08-29 21:07:50 +02:00
<script>
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
window.addEventListener('load', function() {
Improve print output (#680) * Update print styles for new sidebar behavior * Hide copy icons in print output * Wait for mathjax rendering to complete before printing * Remove old wrapping css Browsers this old are already hilariously broken, so we don't need these fallbacks. * Change mathjax script type Chrome won't execute this if it's not marked as js * Ensure page has rendered before printing In certain situations Chrome willl fire window.onLoad before it's done rendering. Add a 100ms delay to work around this.
2018-05-01 07:29:34 -05:00
window.setTimeout(window.print, 100);
});
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
</script>
{{/if}}
{{/if}}
Improve print output (#680) * Update print styles for new sidebar behavior * Hide copy icons in print output * Wait for mathjax rendering to complete before printing * Remove old wrapping css Browsers this old are already hilariously broken, so we don't need these fallbacks. * Change mathjax script type Chrome won't execute this if it's not marked as js * Ensure page has rendered before printing In certain situations Chrome willl fire window.onLoad before it's done rendering. Add a 100ms delay to work around this.
2018-05-01 07:29:34 -05:00
Add support for fragment redirects This adds the ability to redirect URLs with `#` fragments. This is useful when section headers get renamed or moved to other pages. This works both for deleted pages and existing pages. The implementation requires the use of JavaScript in order to manipulate the location. (Ideally this would be handled on the server side.) This also makes it so that deleted page redirects preserve the fragment ID. Previously if you had a deleted page redirect, and the user went to something like `page.html#foo`, it would redirect to `bar.html` without the fragment. I think preserving the fragment is probably a better behavior. If the new page doesn't have the fragment ID, then no harm is really done. This is technically an open redirect, but I don't think that there is too much danger with preserving a fragment ID?
2025-07-08 15:37:46 -07:00
{{#if fragment_map}}
<script>
document.addEventListener('DOMContentLoaded', function() {
const fragmentMap =
{{{fragment_map}}}
;
const target = fragmentMap[window.location.hash];
if (target) {
let url = new URL(target, window.location.href);
window.location.replace(url.href);
}
});
</script>
{{/if}}
fix overflow-x on mobile
2023-01-21 22:41:01 +01:00
</div>
Revert HTML auto-formatting
2020-05-10 09:39:13 +02:00
</body>
First big step for the html renderer, it reads an handlebars template and creates the files from SUMMARY.md respecting the source folder structure
2015-07-19 00:08:38 +02:00
</html>
Reference in a new issue Copy permalink