Interface TocEntry

One heading discovered in the document.

interface TocEntry {
    id: string;
    level: number;
    path: Path;
    text: string;
}

Properties

id: string

Stable-per-render id, used for the href and data- hooks.

level: number

The heading's declared level (1-6), clamped into range.

path: Path

Path of the heading block in the document tree.

text: string

The heading's plain text; empty for an empty heading.