Struct mdbook::config::HtmlConfig

source · [−]

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

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.

Struct mdbook::config::HtmlConfig

Fields

Implementations

impl HtmlConfig

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

Trait Implementations

impl Clone for HtmlConfig

fn clone(&self) -> HtmlConfig

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

impl Debug for HtmlConfig

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

impl Default for HtmlConfig

fn default() -> HtmlConfig

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

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

impl PartialEq<HtmlConfig> for HtmlConfig

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

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

impl Serialize for HtmlConfig

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

impl StructuralPartialEq for HtmlConfig

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,

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

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

fn vzip(self) -> V

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

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

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

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

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

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

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

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

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

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

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

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

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