Interface Heading

Markdown heading.

interface Heading {
    children: PhrasingContent[];
    data?: HeadingData;
    depth: 1 | 2 | 3 | 4 | 5 | 6;
    position?: "/home/runner/work/astro-node-fastify/astro-node-fastify/node_modules/@types/unist/index".Position;
    type: "heading";
}

Hierarchy (view full)

Parent
- Heading

Index

Properties

children data? depth position? type

Properties

children

children: PhrasingContent[]

Children of heading.

`Optional` data

data?: HeadingData

Data associated with the mdast heading.

depth

depth: 1 | 2 | 3 | 4 | 5 | 6

Heading rank.

A value of 1 is said to be the highest rank and 6 the lowest.

`Optional` position

position?: "/home/runner/work/astro-node-fastify/astro-node-fastify/node_modules/@types/unist/index".Position

Position of a node in a source document.

Nodes that are generated (not in the original source document) must not have a position.

type

type: "heading"

Node type of mdast heading.