Heading

Markdown heading.

Extends

• Parent

Properties

children

children: PhrasingContent[]

Children of heading.

Overrides

Parent.children

Defined in

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

---

data?

optional data: HeadingData

Data associated with the mdast heading.

Overrides

Parent.data

Defined in

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

---

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.

Defined in

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

---

position?

optional position: Position

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

Defined in

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

---

type

type: "heading"

Node type of mdast heading.

Overrides

Parent.type

Defined in

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