Interface IMarkdownHeading

Markdown heading

interface IMarkdownHeading {
    collapsed?: boolean;
    dataset?: Record<string, string>;
    level: number;
    line: number;
    prefix?: null | string;
    raw: string;
    skip?: boolean;
    text: string;
}

Hierarchy (view full)

Properties

collapsed? dataset? level line prefix? raw skip? text

Properties

Optional collapsed

collapsed?: boolean

Whether the heading is collapsed or not

Optional dataset

dataset?: Record<string, string>

Dataset to add to the item node

level

level: number

HTML heading level.

line

line: number

Heading line

Optional prefix

prefix?: null | string

Heading prefix.

raw

raw: string

Raw string containing the heading

Optional skip

skip?: boolean

Whether the heading is marked to skip or not

text

text: string

Heading text.

Settings

Member Visibility

Theme

On This Page

collapseddatasetlevellineprefixrawskiptext