Struct pulldown_cmark_toc::Options

pub struct Options { /* private fields */ }

Configuration options to use when rendering the Table of Contents.

Examples

let options = Options::default()
    .item_symbol(ItemSymbol::Asterisk)
    .levels(HeadingLevel::H2..=HeadingLevel::H6)
    .indent(4);

Implementations

impl Options

pub fn item_symbol(self, item_symbol: ItemSymbol) -> Self

The symbol to use for Table of Contents list items.

pub fn levels(self, levels: RangeInclusive<HeadingLevel>) -> Self

Only levels in the given range will be rendered.

pub fn indent(self, indent: usize) -> Self

The number of spaces to use for indentation between heading levels.

pub fn slugifier(self, slugifier: Box<dyn Slugify>) -> Self

The slugifier to use for the heading anchors.

Trait Implementations

impl Default for Options

fn default() -> Self

Returns the “default value” for a type.