]>
git.proxmox.com Git - rustc.git/blob - src/librustdoc/html/static_files.rs
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/css/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/css/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/css/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/css/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/js/main.js");
27 /// The file contents of `search.js`, which contains the search behavior.
28 crate static SEARCH_JS
: &str = include_str
!("static/js/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/js/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/js/storage.js");
38 /// The file contents of `scraped-examples.js`, which contains functionality related to the
39 /// --scrape-examples flag that inserts automatically-found examples of usages of items.
40 crate static SCRAPE_EXAMPLES_JS
: &str = include_str
!("static/js/scrape-examples.js");
42 crate static SCRAPE_EXAMPLES_HELP_MD
: &str = include_str
!("static/scrape-examples-help.md");
44 /// The file contents of `brush.svg`, the icon used for the theme-switch button.
45 crate static BRUSH_SVG
: &[u8] = include_bytes
!("static/images/brush.svg");
47 /// The file contents of `wheel.svg`, the icon used for the settings button.
48 crate static WHEEL_SVG
: &[u8] = include_bytes
!("static/images/wheel.svg");
50 /// The file contents of `clipboard.svg`, the icon used for the "copy path" button.
51 crate static CLIPBOARD_SVG
: &[u8] = include_bytes
!("static/images/clipboard.svg");
53 /// The file contents of `down-arrow.svg`, the icon used for the crate choice combobox.
54 crate static DOWN_ARROW_SVG
: &[u8] = include_bytes
!("static/images/down-arrow.svg");
56 /// The file contents of `toggle-minus.svg`, the icon used for opened toggles.
57 crate static TOGGLE_MINUS_PNG
: &[u8] = include_bytes
!("static/images/toggle-minus.svg");
59 /// The file contents of `toggle-plus.svg`, the icon used for closed toggles.
60 crate static TOGGLE_PLUS_PNG
: &[u8] = include_bytes
!("static/images/toggle-plus.svg");
62 /// The contents of `COPYRIGHT.txt`, the license listing for files distributed with documentation
64 crate static COPYRIGHT
: &[u8] = include_bytes
!("static/COPYRIGHT.txt");
66 /// The contents of `LICENSE-APACHE.txt`, the text of the Apache License, version 2.0.
67 crate static LICENSE_APACHE
: &[u8] = include_bytes
!("static/LICENSE-APACHE.txt");
69 /// The contents of `LICENSE-MIT.txt`, the text of the MIT License.
70 crate static LICENSE_MIT
: &[u8] = include_bytes
!("static/LICENSE-MIT.txt");
72 /// The contents of `rust-logo.svg`, the default icon of the documentation.
73 crate static RUST_LOGO_SVG
: &[u8] = include_bytes
!("static/images/rust-logo.svg");
75 /// The default documentation favicons (SVG and PNG fallbacks)
76 crate static RUST_FAVICON_SVG
: &[u8] = include_bytes
!("static/images/favicon.svg");
77 crate static RUST_FAVICON_PNG_16
: &[u8] = include_bytes
!("static/images/favicon-16x16.png");
78 crate static RUST_FAVICON_PNG_32
: &[u8] = include_bytes
!("static/images/favicon-32x32.png");
80 /// The built-in themes given to every documentation site.
82 /// The "light" theme, selected by default when no setting is available. Used as the basis for
83 /// the `--check-theme` functionality.
84 crate static LIGHT
: &str = include_str
!("static/css/themes/light.css");
87 crate static DARK
: &str = include_str
!("static/css/themes/dark.css");
90 crate static AYU
: &str = include_str
!("static/css/themes/ayu.css");
93 /// Files related to the Fira Sans font.
95 /// The file `FiraSans-Regular.woff2`, the Regular variant of the Fira Sans font in woff2.
96 crate static REGULAR
: &[u8] = include_bytes
!("static/fonts/FiraSans-Regular.woff2");
98 /// The file `FiraSans-Medium.woff2`, the Medium variant of the Fira Sans font in woff2.
99 crate static MEDIUM
: &[u8] = include_bytes
!("static/fonts/FiraSans-Medium.woff2");
101 /// The file `FiraSans-LICENSE.txt`, the license text for the Fira Sans font.
102 crate static LICENSE
: &[u8] = include_bytes
!("static/fonts/FiraSans-LICENSE.txt");
105 /// Files related to the Source Serif 4 font.
106 crate mod source_serif_4
{
107 /// The file `SourceSerif4-Regular.ttf.woff2`, the Regular variant of the Source Serif 4 font in
109 crate static REGULAR
: &[u8] = include_bytes
!("static/fonts/SourceSerif4-Regular.ttf.woff2");
111 /// The file `SourceSerif4-Bold.ttf.woff2`, the Bold variant of the Source Serif 4 font in
113 crate static BOLD
: &[u8] = include_bytes
!("static/fonts/SourceSerif4-Bold.ttf.woff2");
115 /// The file `SourceSerif4-It.ttf.woff2`, the Italic variant of the Source Serif 4 font in
117 crate static ITALIC
: &[u8] = include_bytes
!("static/fonts/SourceSerif4-It.ttf.woff2");
119 /// The file `SourceSerif4-LICENSE.txt`, the license text for the Source Serif 4 font.
120 crate static LICENSE
: &[u8] = include_bytes
!("static/fonts/SourceSerif4-LICENSE.md");
123 /// Files related to the Source Code Pro font.
124 crate mod source_code_pro
{
125 /// The file `SourceCodePro-Regular.ttf.woff2`, the Regular variant of the Source Code Pro font
127 crate static REGULAR
: &[u8] = include_bytes
!("static/fonts/SourceCodePro-Regular.ttf.woff2");
129 /// The file `SourceCodePro-Semibold.ttf.woff2`, the Semibold variant of the Source Code Pro
131 crate static SEMIBOLD
: &[u8] = include_bytes
!("static/fonts/SourceCodePro-Semibold.ttf.woff2");
133 /// The file `SourceCodePro-It.ttf.woff2`, the Italic variant of the Source Code Pro font in
135 crate static ITALIC
: &[u8] = include_bytes
!("static/fonts/SourceCodePro-It.ttf.woff2");
137 /// The file `SourceCodePro-LICENSE.txt`, the license text of the Source Code Pro font.
138 crate static LICENSE
: &[u8] = include_bytes
!("static/fonts/SourceCodePro-LICENSE.txt");
141 /// Files related to the Nanum Barun Gothic font.
143 /// These files are used to avoid some legacy CJK serif fonts in Windows.
145 /// Note that the Noto Sans KR font, which was used previously but was not very readable on Windows,
146 /// has been replaced by the Nanum Barun Gothic font. This is due to Windows' implementation of font
147 /// rendering that distorts OpenType fonts too much.
149 /// The font files were generated with these commands:
152 /// pyftsubset NanumBarunGothic.ttf \
153 /// --unicodes=U+AC00-D7AF,U+1100-11FF,U+3130-318F,U+A960-A97F,U+D7B0-D7FF \
154 /// --output-file=NanumBarunGothic.ttf.woff2 --flavor=woff2
156 crate mod nanum_barun_gothic
{
157 /// The file `NanumBarunGothic.ttf.woff2`, the Regular variant of the Nanum Barun Gothic font.
158 crate static REGULAR
: &[u8] = include_bytes
!("static/fonts/NanumBarunGothic.ttf.woff2");
160 /// The file `NanumBarunGothic-LICENSE.txt`, the license text of the Nanum Barun Gothic font.
161 crate static LICENSE
: &[u8] = include_bytes
!("static/fonts/NanumBarunGothic-LICENSE.txt");
164 /// Files related to the sidebar in rustdoc sources.
166 /// File script to handle sidebar.
167 crate static SOURCE_SCRIPT
: &str = include_str
!("static/js/source-script.js");