mdbook::config

Struct HtmlConfig

Source 
pub struct HtmlConfig {
Show 23 fields
    pub theme: Option<PathBuf>,
    pub default_theme: Option<String>,
    pub preferred_dark_theme: Option<String>,
    pub smart_punctuation: bool,
    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 code: Code,
    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’.

§smart_punctuation: bool

Supports smart quotes, apostrophes, ellipsis, en-dash, and em-dash.

§curly_quotes: bool

Deprecated alias for smart_punctuation.

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

§code: Code

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

§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§

Source§

impl HtmlConfig

Source

pub fn theme_dir(&self, root: &Path) -> PathBuf

Returns the directory of theme from the provided root directory. If the directory is not present it will append the default directory of “theme”

Source

pub fn smart_punctuation(&self) -> bool

Returns true if smart punctuation is enabled.

Trait Implementations§

Source§

impl Clone for HtmlConfig

Source§

fn clone(&self) -> HtmlConfig

Returns a copy of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for HtmlConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for HtmlConfig

Source§

fn default() -> HtmlConfig

Returns the “default value” for a type. Read more
Source§

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

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for HtmlConfig

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for HtmlConfig

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for HtmlConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T