mdast2docx logo Md2Docx
Version 1.8.0API DocsInterfaces

Heading

Updated 5 min ago

Defined in: packages/mdast/src/index.ts:764

Markdown heading.

Extends

Properties

children

children: PhrasingContent[]

Defined in: packages/mdast/src/index.ts:778

Children of heading.

Overrides

Parent.children

data?

optional data?: HeadingData

Defined in: packages/mdast/src/index.ts:782

Data associated with the mdast heading.

Overrides

Parent.data

depth

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

Defined in: packages/mdast/src/index.ts:774

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/.pnpm/@types+unist@3.0.3/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: packages/mdast/src/index.ts:768

Node type of mdast heading.

Overrides

Parent.type

On this page