Core inline rules#

Inline rules for CommonMark, GFM, and mdast directive syntax.

InlineCode#

InlineCode parses inline code spans.

`code`

Output node is InlineCode, and its AST is:

{
  "type": "root",
  "children": [
    {
      "type": "paragraph",
      "children": [
        {
          "type": "inlineCode",
          "value": "code"
        }
      ]
    }
  ]
}

Emphasis#

Emphasis parses emphasis and strong emphasis delimiters.

*em* and **strong**

Output nodes are Emphasis and Strong, and their AST is:

{
  "type": "root",
  "children": [
    {
      "type": "paragraph",
      "children": [
        {
          "type": "emphasis",
          "children": [
            {
              "type": "text",
              "value": "em"
            }
          ]
        },
        {
          "type": "text",
          "value": " and "
        },
        {
          "type": "strong",
          "children": [
            {
              "type": "text",
              "value": "strong"
            }
          ]
        }
      ]
    }
  ]
}

Link#

Link parses inline links and, by default, reference-style links.

[*label*](/url "Title")

Output node is Link, and its AST is:

{
  "type": "root",
  "children": [
    {
      "type": "paragraph",
      "children": [
        {
          "type": "link",
          "children": [
            {
              "type": "emphasis",
              "children": [
                {
                  "type": "text",
                  "value": "label"
                }
              ]
            }
          ],
          "url": "/url",
          "title": "Title"
        }
      ]
    }
  ]
}

Option example: use Link(references=False) when only inline links should be resolved.

[label][id]

[id]: /url

{
  "type": "root",
  "children": [
    {
      "type": "paragraph",
      "children": [
        {
          "type": "text",
          "value": "[label][id]"
        }
      ]
    },
    {
      "type": "paragraph",
      "children": [
        {
          "type": "text",
          "value": "[id]: /url"
        }
      ]
    }
  ]
}

Image#

Image parses inline images and, by default, reference-style images.

![*alt*](/img.png "Title")

Output node is Image, and its AST is:

{
  "type": "root",
  "children": [
    {
      "type": "paragraph",
      "children": [
        {
          "type": "image",
          "url": "/img.png",
          "alt": "alt",
          "title": "Title"
        }
      ]
    }
  ]
}

Option example: use Image(references=False) when only inline images should be resolved.

![alt][id]

[id]: /img.png

{
  "type": "root",
  "children": [
    {
      "type": "paragraph",
      "children": [
        {
          "type": "text",
          "value": "![alt][id]"
        }
      ]
    },
    {
      "type": "paragraph",
      "children": [
        {
          "type": "text",
          "value": "[id]: /img.png"
        }
      ]
    }
  ]
}

Autolink#

Autolink parses angle-bracket URI and email autolinks.

<https://example.com>

Output node is Link, and its AST is:

{
  "type": "root",
  "children": [
    {
      "type": "paragraph",
      "children": [
        {
          "type": "link",
          "children": [
            {
              "type": "text",
              "value": "https://example.com"
            }
          ],
          "url": "https://example.com"
        }
      ]
    }
  ]
}

RawHtml#

RawHtml parses inline HTML tags and comments.

<span>hi</span>

Output node is Html, and its AST is:

{
  "type": "root",
  "children": [
    {
      "type": "paragraph",
      "children": [
        {
          "type": "html",
          "value": "<span>"
        },
        {
          "type": "text",
          "value": "hi"
        },
        {
          "type": "html",
          "value": "</span>"
        }
      ]
    }
  ]
}

Option example: use RawHtml(disallowed_tags=["span"]) to escape selected inline tags during parsing.

Use RawHtml(comment_style="gfm") when a custom rule list needs the stricter GFM 0.29 inline HTML comment grammar. The default comment_style="commonmark" matches the CommonMark preset.

<span>hi</span>

{
  "type": "root",
  "children": [
    {
      "type": "paragraph",
      "children": [
        {
          "type": "html",
          "data": {
            "escaped": true
          },
          "value": "&lt;span>"
        },
        {
          "type": "text",
          "value": "hi"
        },
        {
          "type": "html",
          "data": {
            "escaped": true
          },
          "value": "&lt;/span>"
        }
      ]
    }
  ]
}

BackslashEscape#

BackslashEscape parses backslash escapes for escapable punctuation.

\*

Output node is Text, and its AST is:

{
  "type": "root",
  "children": [
    {
      "type": "paragraph",
      "children": [
        {
          "type": "text",
          "value": "*"
        }
      ]
    }
  ]
}

CharacterReference#

CharacterReference parses named and numeric character references.

&copy;

Output node is Text, and its AST is:

{
  "type": "root",
  "children": [
    {
      "type": "paragraph",
      "children": [
        {
          "type": "text",
          "value": "©"
        }
      ]
    }
  ]
}

HardBreak#

HardBreak parses hard line breaks created with a trailing backslash or two trailing spaces.

line\
break

Output node is Break, and its AST is:

{
  "type": "root",
  "children": [
    {
      "type": "paragraph",
      "children": [
        {
          "type": "text",
          "value": "line"
        },
        {
          "type": "break"
        },
        {
          "type": "text",
          "value": "break"
        }
      ]
    }
  ]
}

Strikethrough#

Strikethrough parses single- or double-tilde deletion spans.

~~delete~~

Output node is Delete, and its AST is:

{
  "type": "root",
  "children": [
    {
      "type": "paragraph",
      "children": [
        {
          "type": "delete",
          "children": [
            {
              "type": "text",
              "value": "delete"
            }
          ]
        }
      ]
    }
  ]
}

ExtendedAutolink#

ExtendedAutolink parses bare URL and email autolinks.

https://example.com

Output node is Link, and its AST is:

{
  "type": "root",
  "children": [
    {
      "type": "paragraph",
      "children": [
        {
          "type": "link",
          "children": [
            {
              "type": "text",
              "value": "https://example.com"
            }
          ],
          "url": "https://example.com"
        }
      ]
    }
  ]
}

TextDirective#

TextDirective parses inline directives such as :name[label]{attrs}.

:abbr[*HTML*]{title="HyperText Markup Language"}

Output node is TextDirective, and its AST is:

{
  "type": "root",
  "children": [
    {
      "type": "paragraph",
      "children": [
        {
          "type": "textDirective",
          "children": [
            {
              "type": "emphasis",
              "children": [
                {
                  "type": "text",
                  "value": "HTML"
                }
              ]
            }
          ],
          "name": "abbr",
          "attributes": {
            "title": "HyperText Markup Language"
          }
        }
      ]
    }
  ]
}