interface TOCGeneratorOptions

Options for the TOC generator processor.

Properties

optional
level: number

Minimum heading level to include in TOC

optional
maxLevel: number

Maximum heading level to include in TOC

optional
key: string

Key in page.data where TOC will be stored

optional
includeTemplateEngines: string[]

Only process pages using these template engines

optional
containerSelector: string

CSS selector to limit heading extraction to a specific container Useful to exclude headings from sidebars, navigation, etc.

Usage

import { type TOCGeneratorOptions } from ".";