Follow us on TwitterFork us on GitHub
MyST

Blocks & Comments

#Block Breaks

Blocks provide a structural divison of the MyST document using +++. These correspond, for example, to separate cells in a Jupyter Notebook. There can be optional metadata associated with the block.

#Specification

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

#Example

Markup
AST
Render

#Comments

You may add comments by putting the % character at the beginning of a line. This will prevent the line from being parsed into the output document.

#Specification

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

#Example

Markup
AST
Render