Struct mdbook_epub::Config

pub struct Config {
    pub additional_css: Vec<PathBuf>,
    pub use_default_css: bool,
    pub index_template: Option<PathBuf>,
    pub cover_image: Option<PathBuf>,
    pub additional_resources: Vec<PathBuf>,
    pub no_section_label: bool,
    pub curly_quotes: bool,
}

The configuration struct used to tweak how an EPUB document is generated.

Fields

additional_css: Vec<PathBuf>

A list of additional stylesheets to include in the document.

use_default_css: bool

Should we use the default stylesheet (default: true)?

index_template: Option<PathBuf>

The template file to use when rendering individual chapters (relative to the book root).

cover_image: Option<PathBuf>

A cover image to use for the epub.

additional_resources: Vec<PathBuf>

Additional assets to include in the ebook, such as typefaces.

no_section_label: bool

Don’t render section labels.

curly_quotes: bool

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

Implementations

impl Config

pub fn from_render_context(ctx: &RenderContext) -> Result<Config, Error>

Get the output.epub table from the provided book.toml config, falling back to the default if

pub fn template(&self) -> Result<String, Error>

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Configwhere
    Config: Default,

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<Config> for Config

fn eq(&self, other: &Config) -> 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 Serialize for Config

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Config