Heading

Defined in: node_modules/@types/mdast/index.d.ts:692

Markdown heading.

Extends

• Parent

Properties

children

children: PhrasingContent[]

Defined in: node_modules/@types/mdast/index.d.ts:706

Children of heading.

Overrides

Parent.children

---

data?

optional data: HeadingData

Defined in: node_modules/@types/mdast/index.d.ts:710

Data associated with the mdast heading.

Overrides

Parent.data

---

depth

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

Defined in: node_modules/@types/mdast/index.d.ts:702

Heading rank.

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

---

position?

optional position: Position

Defined in: node_modules/@types/unist/index.d.ts:103

Position of a node in a source document.

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

Inherited from

Parent.position

---

type

type: "heading"

Defined in: node_modules/@types/mdast/index.d.ts:696

Node type of mdast heading.

Overrides

Parent.type