pub struct HtmlConfig {Show 21 fields
pub theme: Option<PathBuf>,
pub default_theme: Option<String>,
pub preferred_dark_theme: Option<String>,
pub curly_quotes: bool,
pub mathjax_support: bool,
pub copy_fonts: bool,
pub google_analytics: Option<String>,
pub additional_css: Vec<PathBuf>,
pub additional_js: Vec<PathBuf>,
pub fold: Fold,
pub playground: Playground,
pub print: Print,
pub no_section_label: bool,
pub search: Option<Search>,
pub git_repository_url: Option<String>,
pub git_repository_icon: Option<String>,
pub input_404: Option<String>,
pub site_url: Option<String>,
pub cname: Option<String>,
pub edit_url_template: Option<String>,
pub redirect: HashMap<String, String>,
/* private fields */
}Expand description
Configuration for the HTML renderer.
Fields§
§theme: Option<PathBuf>The theme directory, if specified.
default_theme: Option<String>The default theme to use, defaults to ‘light’
preferred_dark_theme: Option<String>The theme to use if the browser requests the dark version of the site. Defaults to ‘navy’.
curly_quotes: boolUse “smart quotes” instead of the usual " character.
mathjax_support: boolShould mathjax be enabled?
copy_fonts: boolWhether to fonts.css and respective font files to the output directory.
google_analytics: Option<String>An optional google analytics code.
additional_css: Vec<PathBuf>Additional CSS stylesheets to include in the rendered page’s <head>.
additional_js: Vec<PathBuf>Additional JS scripts to include at the bottom of the rendered page’s
<body>.
fold: FoldFold settings.
playground: PlaygroundPlayground settings.
print: PrintPrint settings.
no_section_label: boolDon’t render section labels.
search: Option<Search>Search settings. If None, the default will be used.
git_repository_url: Option<String>Git repository url. If None, the git button will not be shown.
git_repository_icon: Option<String>FontAwesome icon class to use for the Git repository link.
Defaults to fa-github if None.
input_404: Option<String>Input path for the 404 file, defaults to 404.md, set to “” to disable 404 file output
site_url: Option<String>Absolute url to site, used to emit correct paths for the 404 page, which might be accessed in a deeply nested directory
cname: Option<String>The DNS subdomain or apex domain at which your book will be hosted. This string will be written to a file named CNAME in the root of your site, as required by GitHub Pages (see Managing a custom domain for your GitHub Pages site).
edit_url_template: Option<String>Edit url template, when set shows a “Suggest an edit” button for directly jumping to editing the currently viewed page. Contains {path} that is replaced with chapter source file path
redirect: HashMap<String, String>The mapping from old pages to new pages/URLs to use when generating redirects.
Implementations§
Trait Implementations§
Source§impl Clone for HtmlConfig
impl Clone for HtmlConfig
Source§fn clone(&self) -> HtmlConfig
fn clone(&self) -> HtmlConfig
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more