Struct Config

pub struct Config {
    pub levels: Vec<usize>,
    pub marker: String,
}

Configuration for Table of Contents generation

Fields

levels: Vec<usize>

Levels for which chapter zero should be applied globally. Defaults to [], which does not apply any global changes. If set to [0], then the top level chapters will be 0 indexed. If set to [1], then the first level of subchapters of ALL chapters will be 0 indexed. If set to [0, 1], then the top level chapters and the first level of subchapters of ALL chapters will be 0 indexed. All (sub-)chapters affected by this setting will ignore the marker.

marker: String

Marker to signify that the direct children of this chapter should be 0 indexed. Defaults to <!-- ch0 -->\n.

Trait Implementations

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl<'a> TryFrom<Option<&'a Map<String, Value>>> for Config

type Error = Error

The type returned in the event of a conversion error.

fn try_from(mdbook_cfg: Option<&Table>) -> Result<Config>

Performs the conversion.