Follow us on TwitterFork us on GitHub
MyST

CommonMark

This page provides an overview of the types of block and inline markup features supported by CommonMark and MyST, with pointers to additional content of interest. For full details on all the nuance of these features, please look at the CommonMark Spec documentation.

MyST (Markedly Structured Text) was designed to make it easier to create publishable computational documents written with Markdown notation. It is a superset of CommonMark Markdown and draws heavy inspiration from RMarkdown syntax. In addition to CommonMark, MyST also implements and extends mdast, which is a standard abstract syntax tree for Markdown. mdast is part of the unifiedjs community and has many utilities for exporting and transforming your content.

#Block Markup

#Headings

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
Markup
AST
Render

#Lists

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
Markup
AST
Render

#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
Markup
AST
Render

#Blockquotes

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

#Thematic Break

Line break

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

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

#Paragraph

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

#Valid 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
Markup
AST
Render

#Inline Markup

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
Markup
AST
Render

#Inline images

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
Markup
AST
Render

#Text formatting

#Emphasis

Stressed, italicized 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

#Inline Code

Fragment of code

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