[−][src]Struct mdbook::config::HtmlConfig

pub struct HtmlConfig {
    pub theme: Option<PathBuf>,
    pub default_theme: Option<String>,
    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>,
    pub git_repository_url: Option<String>,
    pub git_repository_icon: Option<String>,
    // some fields omitted
}

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'

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

Don'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.

Methods

impl HtmlConfig
[src]

pub fn theme_dir(&self, root: &PathBuf) -> PathBuf
[src]

Returns 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 Default for HtmlConfig
[src]

impl PartialEq<HtmlConfig> for HtmlConfig
[src]

impl Clone for HtmlConfig
[src]

fn clone_from(&mut self, source: &Self)
1.0.0
[src]

Performs copy-assignment from source. Read more

impl Debug for HtmlConfig
[src]

impl Serialize for HtmlConfig
[src]

impl<'de> Deserialize<'de> for HtmlConfig where
    HtmlConfig: Default, 
[src]

Auto Trait Implementations

impl Send for HtmlConfig

impl Sync for HtmlConfig

Blanket Implementations

impl<T> From for T
[src]

impl<T, U> Into for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone, 
[src]

type Owned = T

impl<T, U> TryFrom for T where
    T: From<U>, 
[src]

type Error = !

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized, 
[src]

impl<T> BorrowMut for T where
    T: ?Sized, 
[src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> Any for T where
    T: 'static + ?Sized, 
[src]

impl<T> DeserializeOwned for T where
    T: Deserialize<'de>, 
[src]