Type Alias TableOfContents

TableOfContents objects carry hierarchical information about headings and their associated subheadings. They can be used to generate nested lists.

type TableOfContents = {
    children: TableOfContents[];
    level: number;
    parent: TableOfContents | undefined;
    slug: string;
    text: string;
}

Index

Properties

children level parent slug text

Properties

children

children: TableOfContents[]

level

level: number

parent

parent: TableOfContents | undefined

slug

slug: string

text

text: string