Module rustdoc::html::static_files

source ·
Expand description

Static files bundled with documentation output.

All the static files are included here for centralized access in case anything other than the HTML rendering code (say, the theme checker) needs to access one of these files.

Note about types: CSS and JavaScript files are included as &'static str to allow for the minifier to run on them. All other files are included as &'static [u8] so they can be directly written to a Write handle.

Modules

fira_sans 🔒
Files related to the Fira Sans font.
Files related to the Nanum Barun Gothic font.
sidebar 🔒
Files related to the sidebar in rustdoc sources.
Files related to the Source Code Pro font.
Files related to the Source Serif 4 font.
themes 🔒
The built-in themes given to every documentation site.

Statics

The file contents of clipboard.svg, the icon used for the “copy path” button.
COPYRIGHT 🔒
The contents of COPYRIGHT.txt, the license listing for files distributed with documentation output.
The file contents of down-arrow.svg, the icon used for the crate choice combobox.
The contents of LICENSE-APACHE.txt, the text of the Apache License, version 2.0.
The contents of LICENSE-MIT.txt, the text of the MIT License.
MAIN_JS 🔒
The file contents of main.js, which contains the core JavaScript used on documentation pages, including search behavior and docblock folding, among others.
The file contents of normalize.css, included to even out standard elements between browser implementations.
The file contents of the noscript.css file, used in case JS isn’t supported or is disabled.
The file contents of the main rustdoc.css file, responsible for the core layout of the page.
The default documentation favicons (SVG and PNG fallbacks)
The contents of rust-logo.svg, the default icon of the documentation.
The file contents of scraped-examples.js, which contains functionality related to the –scrape-examples flag that inserts automatically-found examples of usages of items.
SEARCH_JS 🔒
The file contents of search.js, which contains the search behavior.
The file contents of settings.css, responsible for the items on the settings page.
The file contents of settings.js, which contains the JavaScript used to handle the settings page.
STORAGE_JS 🔒
The file contents of storage.js, which contains functionality related to browser Local Storage, used to store documentation settings.
The file contents of toggle-minus.svg, the icon used for opened toggles.
The file contents of toggle-plus.svg, the icon used for closed toggles.
WHEEL_SVG 🔒
The file contents of wheel.svg, the icon used for the settings button.