Struct TableOfContents 

pub struct TableOfContents {
    pub min_depth: u8,
    pub max_depth: u8,
    pub auto_insert: bool,
}

Generates a table of contents from document headings and inserts it as a <TableOfContents> component node.

The TOC is inserted at the position of an existing <TableOfContents /> placeholder component, or prepended after frontmatter if no placeholder exists and auto_insert is true.

Configuration

• min_depth / max_depth: heading levels to include (default: 2..=3)
• auto_insert: whether to insert TOC when no placeholder exists (default: false)

Fields

min_depth: u8

max_depth: u8

auto_insert: bool

Trait Implementations

impl Default for TableOfContents

fn default() -> Self

Returns the “default value” for a type.

impl Transform for TableOfContents

fn name(&self) -> &str

A short identifier for this transform (used in error messages / debugging).

fn transform(&self, root: &mut Root, _source: &str)

Apply the transform to the AST. source is the original document text, available for transforms that need to reference raw content.