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/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/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/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/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/main.js");
  26
  27 /// The file contents of `settings.js`, which contains the JavaScript used to handle the settings
  28 /// page.
  29 crate static SETTINGS_JS: &str = include_str!("static/settings.js");
  30
  31 /// The file contents of `storage.js`, which contains functionality related to browser Local
  32 /// Storage, used to store documentation settings.
  33 crate static STORAGE_JS: &str = include_str!("static/storage.js");
  34
  35 /// The file contents of `brush.svg`, the icon used for the theme-switch button.
  36 crate static BRUSH_SVG: &[u8] = include_bytes!("static/brush.svg");
  37
  38 /// The file contents of `wheel.svg`, the icon used for the settings button.
  39 crate static WHEEL_SVG: &[u8] = include_bytes!("static/wheel.svg");
  40
  41 /// The file contents of `down-arrow.svg`, the icon used for the crate choice combobox.
  42 crate static DOWN_ARROW_SVG: &[u8] = include_bytes!("static/down-arrow.svg");
  43
  44 /// The contents of `COPYRIGHT.txt`, the license listing for files distributed with documentation
  45 /// output.
  46 crate static COPYRIGHT: &[u8] = include_bytes!("static/COPYRIGHT.txt");
  47
  48 /// The contents of `LICENSE-APACHE.txt`, the text of the Apache License, version 2.0.
  49 crate static LICENSE_APACHE: &[u8] = include_bytes!("static/LICENSE-APACHE.txt");
  50
  51 /// The contents of `LICENSE-MIT.txt`, the text of the MIT License.
  52 crate static LICENSE_MIT: &[u8] = include_bytes!("static/LICENSE-MIT.txt");
  53
  54 /// The contents of `rust-logo.png`, the default icon of the documentation.
  55 crate static RUST_LOGO: &[u8] = include_bytes!("static/rust-logo.png");
  56 /// The default documentation favicons (SVG and PNG fallbacks)
  57 crate static RUST_FAVICON_SVG: &[u8] = include_bytes!("static/favicon.svg");
  58 crate static RUST_FAVICON_PNG_16: &[u8] = include_bytes!("static/favicon-16x16.png");
  59 crate static RUST_FAVICON_PNG_32: &[u8] = include_bytes!("static/favicon-32x32.png");
  60
  61 /// The built-in themes given to every documentation site.
  62 crate mod themes {
  63     /// The "light" theme, selected by default when no setting is available. Used as the basis for
  64     /// the `--check-theme` functionality.
  65     crate static LIGHT: &str = include_str!("static/themes/light.css");
  66
  67     /// The "dark" theme.
  68     crate static DARK: &str = include_str!("static/themes/dark.css");
  69
  70     /// The "ayu" theme.
  71     crate static AYU: &str = include_str!("static/themes/ayu.css");
  72 }
  73
  74 /// Files related to the Fira Sans font.
  75 crate mod fira_sans {
  76     /// The file `FiraSans-Regular.woff`, the Regular variant of the Fira Sans font.
  77     crate static REGULAR: &[u8] = include_bytes!("static/FiraSans-Regular.woff");
  78
  79     /// The file `FiraSans-Medium.woff`, the Medium variant of the Fira Sans font.
  80     crate static MEDIUM: &[u8] = include_bytes!("static/FiraSans-Medium.woff");
  81
  82     /// The file `FiraSans-LICENSE.txt`, the license text for the Fira Sans font.
  83     crate static LICENSE: &[u8] = include_bytes!("static/FiraSans-LICENSE.txt");
  84 }
  85
  86 /// Files related to the Source Serif Pro font.
  87 crate mod source_serif_pro {
  88     /// The file `SourceSerifPro-Regular.ttf.woff`, the Regular variant of the Source Serif Pro
  89     /// font.
  90     crate static REGULAR: &[u8] = include_bytes!("static/SourceSerifPro-Regular.ttf.woff");
  91
  92     /// The file `SourceSerifPro-Bold.ttf.woff`, the Bold variant of the Source Serif Pro font.
  93     crate static BOLD: &[u8] = include_bytes!("static/SourceSerifPro-Bold.ttf.woff");
  94
  95     /// The file `SourceSerifPro-It.ttf.woff`, the Italic variant of the Source Serif Pro font.
  96     crate static ITALIC: &[u8] = include_bytes!("static/SourceSerifPro-It.ttf.woff");
  97
  98     /// The file `SourceSerifPro-LICENSE.txt`, the license text for the Source Serif Pro font.
  99     crate static LICENSE: &[u8] = include_bytes!("static/SourceSerifPro-LICENSE.md");
 100 }
 101
 102 /// Files related to the Source Code Pro font.
 103 crate mod source_code_pro {
 104     /// The file `SourceCodePro-Regular.woff`, the Regular variant of the Source Code Pro font.
 105     crate static REGULAR: &[u8] = include_bytes!("static/SourceCodePro-Regular.woff");
 106
 107     /// The file `SourceCodePro-Semibold.woff`, the Semibold variant of the Source Code Pro font.
 108     crate static SEMIBOLD: &[u8] = include_bytes!("static/SourceCodePro-Semibold.woff");
 109
 110     /// The file `SourceCodePro-LICENSE.txt`, the license text of the Source Code Pro font.
 111     crate static LICENSE: &[u8] = include_bytes!("static/SourceCodePro-LICENSE.txt");
 112 }
 113
 114 /// Files related to the sidebar in rustdoc sources.
 115 crate mod sidebar {
 116     /// File script to handle sidebar.
 117     crate static SOURCE_SCRIPT: &str = include_str!("static/source-script.js");
 118 }