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 Node
meta: string, optional: Block metadata. Conventionally this is a stringified JSON dictionary but it may be any arbitrary string.
position: object, optional, (Position): See also Node
data: object, optional: See also Node

Example¶

Markup

AST

Render

+++
# Heading!
+++

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 Node
value: string: See also Literal
position: object, optional, (Position): See also Node
data: object, optional: See also Node

Example¶

Markup

AST

Render

Something
% A comment
Something else

type: root
children:
  - type: paragraph
    children:
      - type: text
        value: Something
  - type: mystComment
    value: A comment
  - type: paragraph
    children:
      - type: text
        value: Something else

Important

Since comments are a block-level entity, they will terminate the previous block. In practical terms, this means that the following lines will be broken up into two paragraphs, resulting in a new line between them:

a line
% a comment
another line

a line

another line

Blocks & Comments

Block Breaks¶

Specification¶

Example¶

Heading!¶

Comments¶

Specification¶

Example¶