Struct mdbook::config::HtmlConfig [−][src]
pub struct HtmlConfig {
pub theme: Option<PathBuf>,
pub curly_quotes: bool,
pub mathjax_support: bool,
pub google_analytics: Option<String>,
pub additional_css: Vec<PathBuf>,
pub additional_js: Vec<PathBuf>,
pub playpen: Playpen,
pub no_section_label: bool,
pub search: Option<Search>,
// some fields omitted
}Configuration for the HTML renderer.
Fields
theme: Option<PathBuf>
The theme directory, if specified.
curly_quotes: bool
Use "smart quotes" instead of the usual " character.
mathjax_support: bool
Should mathjax be enabled?
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>.
playpen: Playpen
Playpen settings.
no_section_label: bool
Should section labels be rendered?
search: Option<Search>
Search settings. If None, the default will be used.
Methods
impl HtmlConfig[src]
impl HtmlConfigpub fn theme_dir(&self, root: &PathBuf) -> PathBuf[src]
pub fn theme_dir(&self, root: &PathBuf) -> PathBufReturns the directory of theme from the provided root directory. If the directory is not present it will append the default directory of "theme"
Trait Implementations
impl Debug for HtmlConfig[src]
impl Debug for HtmlConfigfn fmt(&self, f: &mut Formatter) -> Result[src]
fn fmt(&self, f: &mut Formatter) -> ResultFormats the value using the given formatter. Read more
impl Clone for HtmlConfig[src]
impl Clone for HtmlConfigfn clone(&self) -> HtmlConfig[src]
fn clone(&self) -> HtmlConfigReturns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)1.0.0[src]
fn clone_from(&mut self, source: &Self)Performs copy-assignment from source. Read more
impl Default for HtmlConfig[src]
impl Default for HtmlConfigfn default() -> HtmlConfig[src]
fn default() -> HtmlConfigReturns the "default value" for a type. Read more
impl PartialEq for HtmlConfig[src]
impl PartialEq for HtmlConfigfn eq(&self, other: &HtmlConfig) -> bool[src]
fn eq(&self, other: &HtmlConfig) -> boolThis method tests for self and other values to be equal, and is used by ==. Read more
fn ne(&self, other: &HtmlConfig) -> bool[src]
fn ne(&self, other: &HtmlConfig) -> boolThis method tests for !=.
Auto Trait Implementations
impl Send for HtmlConfig
impl Send for HtmlConfigimpl Sync for HtmlConfig
impl Sync for HtmlConfig