src/librustdoc/html/static_files.rs

   1 //! Static files bundled with documentation output.
   2 //!
   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.
   5 //!
   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.
   9
  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/css/rustdoc.css");
  12
  13 /// The file contents of `settings.css`, responsible for the items on the settings page.
  14 crate static SETTINGS_CSS: &str = include_str!("static/css/settings.css");
  15
  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/css/noscript.css");
  18
  19 /// The file contents of `normalize.css`, included to even out standard elements between browser
  20 /// implementations.
  21 crate static NORMALIZE_CSS: &str = include_str!("static/css/normalize.css");
  22
  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/js/main.js");
  26
  27 /// The file contents of `search.js`, which contains the search behavior.
  28 crate static SEARCH_JS: &str = include_str!("static/js/search.js");
  29
  30 /// The file contents of `settings.js`, which contains the JavaScript used to handle the settings
  31 /// page.
  32 crate static SETTINGS_JS: &str = include_str!("static/js/settings.js");
  33
  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/js/storage.js");
  37
  38 /// The file contents of `brush.svg`, the icon used for the theme-switch button.
  39 crate static BRUSH_SVG: &[u8] = include_bytes!("static/images/brush.svg");
  40
  41 /// The file contents of `wheel.svg`, the icon used for the settings button.
  42 crate static WHEEL_SVG: &[u8] = include_bytes!("static/images/wheel.svg");
  43
  44 /// The file contents of `clipboard.svg`, the icon used for the "copy path" button.
  45 crate static CLIPBOARD_SVG: &[u8] = include_bytes!("static/images/clipboard.svg");
  46
  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/images/down-arrow.svg");
  49
  50 /// The contents of `COPYRIGHT.txt`, the license listing for files distributed with documentation
  51 /// output.
  52 crate static COPYRIGHT: &[u8] = include_bytes!("static/COPYRIGHT.txt");
  53
  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");
  56
  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");
  59
  60 /// The contents of `rust-logo.png`, the default icon of the documentation.
  61 crate static RUST_LOGO: &[u8] = include_bytes!("static/images/rust-logo.png");
  62 /// The default documentation favicons (SVG and PNG fallbacks)
  63 crate static RUST_FAVICON_SVG: &[u8] = include_bytes!("static/images/favicon.svg");
  64 crate static RUST_FAVICON_PNG_16: &[u8] = include_bytes!("static/images/favicon-16x16.png");
  65 crate static RUST_FAVICON_PNG_32: &[u8] = include_bytes!("static/images/favicon-32x32.png");
  66
  67 crate static PAGE: &str = include_str!("templates/page.html");
  68
  69 /// The built-in themes given to every documentation site.
  70 crate mod themes {
  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/css/themes/light.css");
  74
  75     /// The "dark" theme.
  76     crate static DARK: &str = include_str!("static/css/themes/dark.css");
  77
  78     /// The "ayu" theme.
  79     crate static AYU: &str = include_str!("static/css/themes/ayu.css");
  80 }
  81
  82 /// Files related to the Fira Sans font.
  83 crate mod fira_sans {
  84     /// The file `FiraSans-Regular.woff`, the Regular variant of the Fira Sans font.
  85     crate static REGULAR: &[u8] = include_bytes!("static/fonts/FiraSans-Regular.woff");
  86
  87     /// The file `FiraSans-Regular.woff2`, the Regular variant of the Fira Sans font in woff2.
  88     crate static REGULAR2: &[u8] = include_bytes!("static/fonts/FiraSans-Regular.woff2");
  89
  90     /// The file `FiraSans-Medium.woff`, the Medium variant of the Fira Sans font.
  91     crate static MEDIUM: &[u8] = include_bytes!("static/fonts/FiraSans-Medium.woff");
  92
  93     /// The file `FiraSans-Medium.woff2`, the Medium variant of the Fira Sans font in woff2.
  94     crate static MEDIUM2: &[u8] = include_bytes!("static/fonts/FiraSans-Medium.woff2");
  95
  96     /// The file `FiraSans-LICENSE.txt`, the license text for the Fira Sans font.
  97     crate static LICENSE: &[u8] = include_bytes!("static/fonts/FiraSans-LICENSE.txt");
  98 }
  99
 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/fonts/SourceSerif4-Regular.ttf.woff");
 104
 105     /// The file `SourceSerif4-Regular.ttf.woff2`, the Regular variant of the Source Serif 4 font in
 106     /// woff2.
 107     crate static REGULAR2: &[u8] = include_bytes!("static/fonts/SourceSerif4-Regular.ttf.woff2");
 108
 109     /// The file `SourceSerif4-Bold.ttf.woff`, the Bold variant of the Source Serif 4 font.
 110     crate static BOLD: &[u8] = include_bytes!("static/fonts/SourceSerif4-Bold.ttf.woff");
 111
 112     /// The file `SourceSerif4-Bold.ttf.woff2`, the Bold variant of the Source Serif 4 font in
 113     /// woff2.
 114     crate static BOLD2: &[u8] = include_bytes!("static/fonts/SourceSerif4-Bold.ttf.woff2");
 115
 116     /// The file `SourceSerif4-It.ttf.woff`, the Italic variant of the Source Serif 4 font.
 117     crate static ITALIC: &[u8] = include_bytes!("static/fonts/SourceSerif4-It.ttf.woff");
 118
 119     /// The file `SourceSerif4-It.ttf.woff2`, the Italic variant of the Source Serif 4 font in
 120     /// woff2.
 121     crate static ITALIC2: &[u8] = include_bytes!("static/fonts/SourceSerif4-It.ttf.woff2");
 122
 123     /// The file `SourceSerif4-LICENSE.txt`, the license text for the Source Serif 4 font.
 124     crate static LICENSE: &[u8] = include_bytes!("static/fonts/SourceSerif4-LICENSE.md");
 125 }
 126
 127 /// Files related to the Source Code Pro font.
 128 crate mod source_code_pro {
 129     /// The file `SourceCodePro-Regular.ttf.woff`, the Regular variant of the Source Code Pro font.
 130     crate static REGULAR: &[u8] = include_bytes!("static/fonts/SourceCodePro-Regular.ttf.woff");
 131
 132     /// The file `SourceCodePro-Regular.ttf.woff2`, the Regular variant of the Source Code Pro font
 133     /// in woff2.
 134     crate static REGULAR2: &[u8] = include_bytes!("static/fonts/SourceCodePro-Regular.ttf.woff2");
 135
 136     /// The file `SourceCodePro-Semibold.ttf.woff`, the Semibold variant of the Source Code Pro
 137     /// font.
 138     crate static SEMIBOLD: &[u8] = include_bytes!("static/fonts/SourceCodePro-Semibold.ttf.woff");
 139
 140     /// The file `SourceCodePro-Semibold.ttf.woff2`, the Semibold variant of the Source Code Pro
 141     /// font in woff2.
 142     crate static SEMIBOLD2: &[u8] = include_bytes!("static/fonts/SourceCodePro-Semibold.ttf.woff2");
 143
 144     /// The file `SourceCodePro-It.ttf.woff`, the Italic variant of the Source Code Pro font.
 145     crate static ITALIC: &[u8] = include_bytes!("static/fonts/SourceCodePro-It.ttf.woff");
 146
 147     /// The file `SourceCodePro-It.ttf.woff2`, the Italic variant of the Source Code Pro font in
 148     /// woff2.
 149     crate static ITALIC2: &[u8] = include_bytes!("static/fonts/SourceCodePro-It.ttf.woff2");
 150
 151     /// The file `SourceCodePro-LICENSE.txt`, the license text of the Source Code Pro font.
 152     crate static LICENSE: &[u8] = include_bytes!("static/fonts/SourceCodePro-LICENSE.txt");
 153 }
 154
 155 crate mod noto_sans_kr {
 156     /// The file `noto-sans-kr-v13-korean-regular.woff`, the Regular variant of the Noto Sans KR
 157     /// font.
 158     crate static REGULAR: &[u8] =
 159         include_bytes!("static/fonts/noto-sans-kr-v13-korean-regular.woff");
 160
 161     /// The file `noto-sans-kr-v13-korean-regular-LICENSE.txt`, the license text of the Noto Sans KR
 162     /// font.
 163     crate static LICENSE: &[u8] =
 164         include_bytes!("static/fonts/noto-sans-kr-v13-korean-regular-LICENSE.txt");
 165 }
 166
 167 /// Files related to the sidebar in rustdoc sources.
 168 crate mod sidebar {
 169     /// File script to handle sidebar.
 170     crate static SOURCE_SCRIPT: &str = include_str!("static/js/source-script.js");
 171 }