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

pub struct HtmlConfig {
    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 redirect: HashMap<String, 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'

preferred_dark_theme: Option<String>

The theme to use if the browser requests the dark version of the site. Defaults to 'navy'.

curly_quotes: bool

Use "smart quotes" instead of the usual " character.

mathjax_support: bool

Should mathjax be enabled?

copy_fonts: bool

Whether 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: Fold

Fold settings.

playground: Playground

Playground settings.

print: Print

Print 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.

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).

redirect: HashMap<String, String>

The mapping from old pages to new pages/URLs to use when generating redirects.

Implementations

`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 Clone for HtmlConfig`[src]

`fn clone(&self) -> HtmlConfig`[src]

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

`impl Debug for HtmlConfig`[src]

`fn fmt(&self, f: &mut Formatter<'_>) -> Result`[src]

`impl Default for HtmlConfig`[src]

`fn default() -> HtmlConfig`[src]

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

`fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where __D: Deserializer<'de>,` [src]

`impl PartialEq<HtmlConfig> for HtmlConfig`[src]

`fn eq(&self, other: &HtmlConfig) -> bool`[src]

`fn ne(&self, other: &HtmlConfig) -> bool`[src]

`impl Serialize for HtmlConfig`[src]

`fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where S: Serializer,` [src]

`impl StructuralPartialEq for HtmlConfig`[src]

Auto Trait Implementations

`impl RefUnwindSafe for HtmlConfig`

`impl Send for HtmlConfig`

`impl Sync for HtmlConfig`

`impl Unpin for HtmlConfig`

`impl UnwindSafe for HtmlConfig`

Blanket Implementations

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

`fn type_id(&self) -> TypeId`[src]

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

`fn borrow(&self) -> &T`[src]

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

`fn borrow_mut(&mut self) -> &mut T`[src]

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

`impl<T> From<T> for T`[src]

`fn from(t: T) -> T`[src]

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

`fn into(self) -> U`[src]

`impl<T> Same<T> for T`

`type Output = T`

Should always be Self

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

`type Owned = T`

The resulting type after obtaining ownership.

`fn to_owned(&self) -> T`[src]

`fn clone_into(&self, target: &mut T)`[src]

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

`type Error = Infallible`

The type returned in the event of a conversion error.

`fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>`[src]

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

`type Error = >::Error`

The type returned in the event of a conversion error.

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

Fields

Implementations

impl HtmlConfig[src]

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

Trait Implementations

impl Clone for HtmlConfig[src]

fn clone(&self) -> HtmlConfig[src]

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

impl Debug for HtmlConfig[src]

fn fmt(&self, f: &mut Formatter<'_>) -> Result[src]

impl Default for HtmlConfig[src]

fn default() -> HtmlConfig[src]

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where __D: Deserializer<'de>, [src]

impl PartialEq<HtmlConfig> for HtmlConfig[src]

fn eq(&self, other: &HtmlConfig) -> bool[src]

fn ne(&self, other: &HtmlConfig) -> bool[src]

impl Serialize for HtmlConfig[src]

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where __S: Serializer, [src]

impl StructuralPartialEq for HtmlConfig[src]

Auto Trait Implementations

impl RefUnwindSafe for HtmlConfig

impl Send for HtmlConfig

impl Sync for HtmlConfig

impl Unpin for HtmlConfig

impl UnwindSafe for HtmlConfig

Blanket Implementations

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

fn type_id(&self) -> TypeId[src]

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

fn borrow(&self) -> &T[src]

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

fn borrow_mut(&mut self) -> &mut T[src]

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

impl<T> From<T> for T[src]

fn from(t: T) -> T[src]

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

fn into(self) -> U[src]

impl<T> Same<T> for T

type Output = T

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

type Owned = T

fn to_owned(&self) -> T[src]

fn clone_into(&self, target: &mut T)[src]

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

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

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

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

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V