1 //! Static files bundled with documentation output.
3 //! All the static files are included here for centralized access in case anything other than the
4 //! HTML rendering code (say, the theme checker) needs to access one of these files.
6 //! Note about types: CSS and JavaScript files are included as `&'static str` to allow for the
7 //! minifier to run on them. All other files are included as `&'static [u8]` so they can be
8 //! directly written to a `Write` handle.
10 /// The file contents of the main `rustdoc.css` file, responsible for the core layout of the page.
11 crate static RUSTDOC_CSS: &str = include_str!("static/rustdoc.css");
13 /// The file contents of `settings.css`, responsible for the items on the settings page.
14 crate static SETTINGS_CSS: &str = include_str!("static/settings.css");
16 /// The file contents of the `noscript.css` file, used in case JS isn't supported or is disabled.
17 crate static NOSCRIPT_CSS: &str = include_str!("static/noscript.css");
19 /// The file contents of `normalize.css`, included to even out standard elements between browser
21 crate static NORMALIZE_CSS: &str = include_str!("static/normalize.css");
23 /// The file contents of `main.js`, which contains the core JavaScript used on documentation pages,
24 /// including search behavior and docblock folding, among others.
25 crate static MAIN_JS: &str = include_str!("static/main.js");
27 /// The file contents of `search.js`, which contains the search behavior.
28 crate static SEARCH_JS: &str = include_str!("static/search.js");
30 /// The file contents of `settings.js`, which contains the JavaScript used to handle the settings
32 crate static SETTINGS_JS: &str = include_str!("static/settings.js");
34 /// The file contents of `storage.js`, which contains functionality related to browser Local
35 /// Storage, used to store documentation settings.
36 crate static STORAGE_JS: &str = include_str!("static/storage.js");
38 /// The file contents of `brush.svg`, the icon used for the theme-switch button.
39 crate static BRUSH_SVG: &[u8] = include_bytes!("static/brush.svg");
41 /// The file contents of `wheel.svg`, the icon used for the settings button.
42 crate static WHEEL_SVG: &[u8] = include_bytes!("static/wheel.svg");
44 /// The file contents of `clipboard.svg`, the icon used for the "copy path" button.
45 crate static CLIPBOARD_SVG: &[u8] = include_bytes!("static/clipboard.svg");
47 /// The file contents of `down-arrow.svg`, the icon used for the crate choice combobox.
48 crate static DOWN_ARROW_SVG: &[u8] = include_bytes!("static/down-arrow.svg");
50 /// The contents of `COPYRIGHT.txt`, the license listing for files distributed with documentation
52 crate static COPYRIGHT: &[u8] = include_bytes!("static/COPYRIGHT.txt");
54 /// The contents of `LICENSE-APACHE.txt`, the text of the Apache License, version 2.0.
55 crate static LICENSE_APACHE: &[u8] = include_bytes!("static/LICENSE-APACHE.txt");
57 /// The contents of `LICENSE-MIT.txt`, the text of the MIT License.
58 crate static LICENSE_MIT: &[u8] = include_bytes!("static/LICENSE-MIT.txt");
60 /// The contents of `rust-logo.png`, the default icon of the documentation.
61 crate static RUST_LOGO: &[u8] = include_bytes!("static/rust-logo.png");
62 /// The default documentation favicons (SVG and PNG fallbacks)
63 crate static RUST_FAVICON_SVG: &[u8] = include_bytes!("static/favicon.svg");
64 crate static RUST_FAVICON_PNG_16: &[u8] = include_bytes!("static/favicon-16x16.png");
65 crate static RUST_FAVICON_PNG_32: &[u8] = include_bytes!("static/favicon-32x32.png");
67 crate static PAGE: &str = include_str!("templates/page.html");
69 /// The built-in themes given to every documentation site.
71 /// The "light" theme, selected by default when no setting is available. Used as the basis for
72 /// the `--check-theme` functionality.
73 crate static LIGHT: &str = include_str!("static/themes/light.css");
76 crate static DARK: &str = include_str!("static/themes/dark.css");
79 crate static AYU: &str = include_str!("static/themes/ayu.css");
82 /// Files related to the Fira Sans font.
84 /// The file `FiraSans-Regular.woff`, the Regular variant of the Fira Sans font.
85 crate static REGULAR: &[u8] = include_bytes!("static/FiraSans-Regular.woff");
87 /// The file `FiraSans-Regular.woff2`, the Regular variant of the Fira Sans font in woff2.
88 crate static REGULAR2: &[u8] = include_bytes!("static/FiraSans-Regular.woff2");
90 /// The file `FiraSans-Medium.woff`, the Medium variant of the Fira Sans font.
91 crate static MEDIUM: &[u8] = include_bytes!("static/FiraSans-Medium.woff");
93 /// The file `FiraSans-Medium.woff2`, the Medium variant of the Fira Sans font in woff2.
94 crate static MEDIUM2: &[u8] = include_bytes!("static/FiraSans-Medium.woff2");
96 /// The file `FiraSans-LICENSE.txt`, the license text for the Fira Sans font.
97 crate static LICENSE: &[u8] = include_bytes!("static/FiraSans-LICENSE.txt");
100 /// Files related to the Source Serif 4 font.
101 crate mod source_serif_4 {
102 /// The file `SourceSerif4-Regular.ttf.woff`, the Regular variant of the Source Serif 4 font.
103 crate static REGULAR: &[u8] = include_bytes!("static/SourceSerif4-Regular.ttf.woff");
105 /// The file `SourceSerif4-Bold.ttf.woff`, the Bold variant of the Source Serif 4 font.
106 crate static BOLD: &[u8] = include_bytes!("static/SourceSerif4-Bold.ttf.woff");
108 /// The file `SourceSerif4-It.ttf.woff`, the Italic variant of the Source Serif 4 font.
109 crate static ITALIC: &[u8] = include_bytes!("static/SourceSerif4-It.ttf.woff");
111 /// The file `SourceSerif4-LICENSE.txt`, the license text for the Source Serif 4 font.
112 crate static LICENSE: &[u8] = include_bytes!("static/SourceSerif4-LICENSE.md");
115 /// Files related to the Source Code Pro font.
116 crate mod source_code_pro {
117 /// The file `SourceCodePro-Regular.ttf.woff`, the Regular variant of the Source Code Pro font.
118 crate static REGULAR: &[u8] = include_bytes!("static/SourceCodePro-Regular.ttf.woff");
120 /// The file `SourceCodePro-Semibold.ttf.woff`, the Semibold variant of the Source Code Pro
122 crate static SEMIBOLD: &[u8] = include_bytes!("static/SourceCodePro-Semibold.ttf.woff");
124 /// The file `SourceCodePro-It.ttf.woff`, the Italic variant of the Source Code Pro font.
125 crate static ITALIC: &[u8] = include_bytes!("static/SourceCodePro-It.ttf.woff");
127 /// The file `SourceCodePro-LICENSE.txt`, the license text of the Source Code Pro font.
128 crate static LICENSE: &[u8] = include_bytes!("static/SourceCodePro-LICENSE.txt");
131 crate mod noto_sans_kr {
132 /// The file `noto-sans-kr-v13-korean-regular.woff`, the Regular variant of the Noto Sans KR
134 crate static REGULAR: &[u8] = include_bytes!("static/noto-sans-kr-v13-korean-regular.woff");
136 /// The file `noto-sans-kr-v13-korean-regular-LICENSE.txt`, the license text of the Noto Sans KR
138 crate static LICENSE: &[u8] =
139 include_bytes!("static/noto-sans-kr-v13-korean-regular-LICENSE.txt");
142 /// Files related to the sidebar in rustdoc sources.
144 /// File script to handle sidebar.
145 crate static SOURCE_SCRIPT: &str = include_str!("static/source-script.js");