Struct mdbook::theme::Theme

pub struct Theme {

    pub index: Vec<u8>,
    pub head: Vec<u8>,
    pub redirect: Vec<u8>,
    pub header: Vec<u8>,
    pub chrome_css: Vec<u8>,
    pub general_css: Vec<u8>,
    pub print_css: Vec<u8>,
    pub variables_css: Vec<u8>,
    pub fonts_css: Option<Vec<u8>>,
    pub font_files: Vec<PathBuf>,
    pub favicon_png: Option<Vec<u8>>,
    pub favicon_svg: Option<Vec<u8>>,
    pub js: Vec<u8>,
    pub highlight_css: Vec<u8>,
    pub tomorrow_night_css: Vec<u8>,
    pub ayu_highlight_css: Vec<u8>,
    pub highlight_js: Vec<u8>,
    pub clipboard_js: Vec<u8>,
}

The Theme struct should be used instead of the static variables because the new() method will look if the user has a theme directory in their source folder and use the users theme instead of the default.

You should only ever use the static variables directly if you want to override the user’s theme with the defaults.

Fields

index: Vec<u8>

head: Vec<u8>

redirect: Vec<u8>

header: Vec<u8>

chrome_css: Vec<u8>

general_css: Vec<u8>

print_css: Vec<u8>

variables_css: Vec<u8>

fonts_css: Option<Vec<u8>>

font_files: Vec<PathBuf>

favicon_png: Option<Vec<u8>>

favicon_svg: Option<Vec<u8>>

js: Vec<u8>

highlight_css: Vec<u8>

tomorrow_night_css: Vec<u8>

ayu_highlight_css: Vec<u8>

highlight_js: Vec<u8>

clipboard_js: Vec<u8>

Implementations

impl Theme

pub fn new<P: AsRef<Path>>(theme_dir: P) -> Self

Creates a Theme from the given theme_dir. If a file is found in the theme dir, it will override the default version.

Trait Implementations

impl Debug for Theme

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

Formats the value using the given formatter.

impl Default for Theme

fn default() -> Theme

Returns the “default value” for a type.

impl PartialEq for Theme

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Theme