Follow us on TwitterFork us on GitHub
MyST

Node Type Index

#FlowContent

Any of | | | | | | | | | | | | | | |

#ListContent

Only

#PhrasingContent

Any of | | | | | | | | | |

#StaticPhrasingContent

Any of | | | | | | | | | | | |

#BlockBreak

Top-level break in the myst document, breaking it into Blocks

type: string, ("blockBreak")
See also
meta: string, optional
Block metadata. Conventionally this is a stringified JSON dictionary but it may be any arbitrary string.
position: object, optional, ()
See also
data: object, optional
See also

#Block

Top-level content blocks or cells the myst document, delimited by BlockBreaks

type: string, ("block")
See also
meta: string, optional
block metadata from preceding break; conventionally, a stringified JSON dictionary but may be any arbitrary string
children: array, optional, ( | | )
Top-level children of myst document
position: object, optional, ()
See also
data: object, optional
See also

#Role

Custom in-line behavior

type: string, ("mystRole")
See also
name: string
No description for this property.
value: string, optional
content of the directive
children: array, optional, ()
parsed role content
position: object, optional, ()
See also
data: object, optional
See also

#Directive

Content block with predefined behavior

type: string, ("mystDirective")
See also
name: string
No description for this property.
args: string, optional
No description for this property.
options: object, optional
No description for this property.
value: string, optional
body of the directive, excluding options
children: array, optional, ( | )
parsed directive content
position: object, optional, ()
See also
data: object, optional
See also

#Target

Target node - provides identifier/label for the following node

type: string, ("mystTarget")
See also
label: string, optional
unresolved target label
position: object, optional, ()
See also
data: object, optional
See also

#CrossReference

In-line reference to an associated node

type: string, ("crossReference")
See also
kind: string, optional, ("eq" | "numref" | "ref")
Indicates if the references should be numbered.
children: array, optional, ()
Children of the crossReference, can include text with "%s" or "{number}" and enumerated references will be filled in.
identifier: string
See also
label: string, optional
See also
position: object, optional, ()
See also
data: object, optional
See also

#Abbreviation

Abbreviation node described by title

type: string, ("abbreviation")
See also
children: array, ()
abbreviated value
See also
title: string, optional
advisory information for the abbreviation
position: object, optional, ()
See also
data: object, optional
See also

#Admonition

Admonition node for drawing attention to text, separate from the neighboring content

type: string, ("admonition")
See also
kind: string, optional, ("attention" | "caution" | "danger" | "error" | "hint" | "important" | "note" | "seealso" | "tip" | "warning")
kind of admonition, to determine styling
class: string, optional
admonition class info to override kind
children: array, ( | )
An optional admonitionTitle followed by the admonitions content.
See also
position: object, optional, ()
See also
data: object, optional
See also

#AdmonitionTitle

Custom title for admonition, replaces kind as title

type: string, ("admonitionTitle")
See also
children: array, ()
See also
position: object, optional, ()
See also
data: object, optional
See also

#Container

Top-level container node to provide association and numbering to child content

type: string, ("container")
See also
kind: string, ("figure" | "table")
kind of container contents
class: string, optional
any custom class information
enumerated: boolean, optional
count this container for numbering based on kind, e.g. Figure 1a
enumerator: string, optional
resolved enumerated value for this container
children: array, ( | | | )
See also
identifier: string, optional
See also
label: string, optional
See also
position: object, optional, ()
See also
data: object, optional
See also

#Caption

Caption for container content

type: string, ("caption")
See also
children: array, ()
See also
position: object, optional, ()
See also
data: object, optional
See also

#Legend

Legend for container content

type: string, ("legend")
See also
children: array, ()
See also
position: object, optional, ()
See also
data: object, optional
See also

#FootnoteReference

Inline reference to footnote

type: string, ("footnoteReference")
See also
identifier: string
See also
label: string, optional
See also
position: object, optional, ()
See also
data: object, optional
See also

#FootnoteDefinition

Rich footnote content associated with footnote reference

type: string, ("footnoteDefinition")
See also
children: array, ()
See also
identifier: string
See also
label: string, optional
See also
position: object, optional, ()
See also
data: object, optional
See also

#Math

Math node for presenting numbered equations

type: string, ("math")
See also
enumerated: boolean, optional
count this math block for numbering based on kind, e.g. See equation (1a)
enumerator: string, optional
resolved enumerated value for this math block
identifier: string, optional
See also
label: string, optional
See also
value: string
See also
position: object, optional, ()
See also
data: object, optional
See also

#InlineMath

Fragment of math, similar to InlineCode, using role {math}

type: string, ("inlineMath")
See also
value: string
See also
position: object, optional, ()
See also
data: object, optional
See also

#Table

Two-dimensional table data

type: string, ("table")
See also
align: string, optional, ("left" | "center" | "right")
No description for this property.
children: array, ()
See also
position: object, optional, ()
See also
data: object, optional
See also

#TableRow

One row of table containing cells

type: string, ("tableRow")
See also
children: array, ()
See also
position: object, optional, ()
See also
data: object, optional
See also

#TableCell

One cell of table

type: string, ("tableCell")
See also
header: boolean, optional
No description for this property.
align: string, optional, ("left" | "center" | "right")
alignment of content within cell
children: array, ()
See also
position: object, optional, ()
See also
data: object, optional
See also

#Subscript

Subscript content, using role {subscript}

type: string, ("subscript")
See also
children: array, ()
See also
position: object, optional, ()
See also
data: object, optional
See also

#SubscriptStatic

Subscript content, with static children; used when parent node requires static content

type: string, ("subscript")
See also
children: array, ()
See also
position: object, optional, ()
See also
data: object, optional
See also

#Superscript

Superscript content, using role {superscript}

type: string, ("superscript")
See also
children: array, ()
See also
position: object, optional, ()
See also
data: object, optional
See also

#SuperscriptStatic

Superscript content, with static children; used when parent node requires static content

type: string, ("superscript")
See also
children: array, ()
See also
position: object, optional, ()
See also
data: object, optional
See also

#Underline

Underline content, using role {underline}

type: string, ("underline")
See also
children: array, ()
See also
position: object, optional, ()
See also
data: object, optional
See also

#UnderlineStatic

Underline content, with static children; used when parent node requires static content

type: string, ("underline")
See also
children: array, ()
See also
position: object, optional, ()
See also
data: object, optional
See also

#Comment

Comment nodes for comments present in myst but ingnored upon render

type: string, ("mystComment")
See also
value: string
See also
position: object, optional, ()
See also
data: object, optional
See also

#Paragraph

type: string, ("paragraph")
See also
children: array, ()
See also
position: object, optional, ()
See also
data: object, optional
See also

#Heading

type: string, ("heading")
See also
depth: integer
No description for this property.
enumerated: boolean, optional
count this heading for numbering based on kind, e.g. Section 2.4.1
enumerator: string, optional
resolved enumerated value for this heading
children: array, ()
See also
identifier: string, optional
See also
label: string, optional
See also
position: object, optional, ()
See also
data: object, optional
See also

#ThematicBreak

type: string, ("thematicBreak")
See also
position: object, optional, ()
See also
data: object, optional
See also

#Blockquote

type: string, ("blockquote")
See also
children: array, ()
See also
position: object, optional, ()
See also
data: object, optional
See also

#List

type: string, ("list")
See also
ordered: boolean, optional
Is item order important or not?
start: integer, optional
Starting number of ordered list
spread: boolean, optional
One or more children are separated with a blank line from others
children: array, ()
See also
position: object, optional, ()
See also
data: object, optional
See also

#ListItem

type: string, ("listItem")
See also
spread: boolean, optional
One or more children are separated with a blank line from others
children: array, ( | )
See also
position: object, optional, ()
See also
data: object, optional
See also

#HTML

Fragment of raw HTML - does not need to be valid or complete

type: string, ("html")
See also
value: string
See also
position: object, optional, ()
See also
data: object, optional
See also

#Code

Block of preformatted text

type: string, ("code")
See also
lang: string, optional
language of the code
meta: string, optional
custom information relating to the node
class: string, optional
user-defined class for code block
showLineNumbers: boolean, optional
No description for this property.
startingLineNumber: integer, optional
No description for this property.
emphasizeLines: array, optional, (integer)
No description for this property.
identifier: string, optional
See also
label: string, optional
See also
value: string
See also
position: object, optional, ()
See also
data: object, optional
See also

#Definition

Reference to a url resource

type: string, ("definition")
See also
identifier: string
See also
label: string, optional
See also
url: string
See also
title: string, optional
See also
position: object, optional, ()
See also
data: object, optional
See also

#Text

type: string, ("text")
See also
value: string
See also
position: object, optional, ()
See also
data: object, optional
See also

#Emphasis

Stressed, italicized content

type: string, ("emphasis")
See also
children: array, ()
See also
position: object, optional, ()
See also
data: object, optional
See also

#EmphasisStatic

Stressed, italicized content, with static children; used when parent node requires static content

type: string, ("emphasis")
See also
children: array, ()
See also
position: object, optional, ()
See also
data: object, optional
See also

#Strong

Important, serious, urgent, bold content

type: string, ("strong")
See also
children: array, ()
See also
position: object, optional, ()
See also
data: object, optional
See also

#StrongStatic

Important, serious, urgent, bold content, with static children; used when parent node requires static content

type: string, ("strong")
See also
children: array, ()
See also
position: object, optional, ()
See also
data: object, optional
See also

#InlineCode

Fragment of code

type: string, ("inlineCode")
See also
value: string
See also
position: object, optional, ()
See also
data: object, optional
See also

#Break

Line break

type: string, ("break")
See also
position: object, optional, ()
See also
data: object, optional
See also

Hyperlink

type: string, ("link")
See also
children: array, ()
See also
url: string
See also
title: string, optional
See also
position: object, optional, ()
See also
data: object, optional
See also

#Image

Image hyperlink

type: string, ("image")
See also
class: string, optional
user-defined class for image
width: string, optional
image width in pixels or percentage
align: string, optional, ("left" | "center" | "right")
No description for this property.
url: string
See also
title: string, optional
See also
alt: string, optional
See also
position: object, optional, ()
See also
data: object, optional
See also

#LinkReference

Hyperlink through association

type: string, ("linkReference")
See also
children: array, ()
See also
referenceType: string, ("shortcut" | "collapsed" | "full")
See also
identifier: string
See also
label: string, optional
See also
position: object, optional, ()
See also
data: object, optional
See also

#ImageReference

Image through association

type: string, ("imageReference")
See also
referenceType: string, ("shortcut" | "collapsed" | "full")
See also
identifier: string
See also
label: string, optional
See also
alt: string, optional
See also
position: object, optional, ()
See also
data: object, optional
See also

#Resource

Reference to external resource

url: string
A Uniform Resource Locator (URL) to an external resource or link.
title: string, optional
advisory information, e.g. for a tooltip

#OptionalAssociation

Internal relation from one node to another; not required by node

identifier: string, optional
identifier that may match another node; value is unparsed and must be normalized such that whitespace is collapsed to single space, initial/final space is trimmed, and case is folded
label: string, optional
node label; character escapes and references are parsed; may be normalized to a unique identifier

#Association

Internal relation from one node to another

identifier: string
See also
label: string, optional
node label; character escapes and references are parsed; may be normalized to a unique identifier
See also

#Alternative

Alternative description of image

alt: string, optional
field describing the image

#Reference

Marker associated to another node

referenceType: string, ("shortcut" | "collapsed" | "full")
explicitness of the reference: shortcut - reference is implicit, identifier inferred collapsed - reference explicit, identifier inferred full - reference explicit, identifier explicit

#Node

Base node object, based on the unist syntax tree.

type: string
identifier for node variant
data: object, optional
information associated by the ecosystem with the node; never specified by mdast
position: object, optional, ()
location of node in source file; must not be present for generated nodes

#Literal

Basic node with required string value

value: string
The value of the node
type: string
identifier for node variant
See also
data: object, optional
information associated by the ecosystem with the node; never specified by mdast
See also
position: object, optional, ()
location of node in source file; must not be present for generated nodes
See also

#Parent

Basic node with required node children

children: array, ()
List of children nodes
type: string
identifier for node variant
See also
data: object, optional
information associated by the ecosystem with the node; never specified by mdast
See also
position: object, optional, ()
location of node in source file; must not be present for generated nodes
See also

#Point

One place in a source file

line: integer
line in the source file, 1-indexed
column: integer
column in the source file, 1-indexed
offset: integer, optional
offset character in the source file, 0-indexed

#Position

Location of a node in a source file

start: object, ()
place of first character of parsed source region
end: object, ()
place of first character after parsed source region, whether it exists or not
indent: array, optional, (integer)
start column at each index in the source region, for elements that span multiple lines

#Root

Myst syntax tree built on existing mdast schemas

type: string, ("root")
See also
children: array, ( | | )
Top-level children of myst document
See also
position: object, optional, ()
See also
data: object, optional
See also