mdast2docx logo Md2Docx
Version 0.2.4API DocsInterfaces

Definition

Updated 5 min ago

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

Markdown definition.

Extends

Properties

data?

optional data?: DefinitionData

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

Data associated with the mdast definition.

Overrides

Node.data

identifier

identifier: string

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

Relation of association.

identifier is a source value: character escapes and character references are not parsed.

It can match another node.

Its value must be normalized. To normalize a value, collapse markdown whitespace ([\t\n\r ]+) to a space, trim the optional initial and/or final space, and perform Unicode-aware case-folding.

Inherited from

Association.identifier

label?

optional label?: string | null

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

Relation of association, in parsed form.

label is a string value: it works just like title on Link or a lang on Code: character escapes and character references are parsed.

It can match another node.

Inherited from

Association.label

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

Node.position

title?

optional title?: string | null

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

Advisory information for the resource, such as would be appropriate for a tooltip.

Inherited from

Resource.title

type

type: "definition"

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

Node type of mdast definition.

Overrides

Node.type

url

url: string

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

URL to the referenced resource.

Inherited from

Resource.url

On this page