Wenmode
Core block rules#
Block-level rules for CommonMark, GFM, and mdast directive syntax.
AtxHeading#
AtxHeading parses hash-prefixed ATX headings from level 1 through level 6.
# Title
Output node is Heading, and its AST is:
{
"type": "root",
"children": [
{
"type": "heading",
"children": [
{
"type": "text",
"value": "Title"
}
],
"depth": 1
}
]
}
Option example: use AtxHeading(transforms=[HeadingIdTransform()]) to add
generated heading IDs.
# Hello World
{
"type": "root",
"children": [
{
"type": "heading",
"data": {
"id": "hello-world"
},
"children": [
{
"type": "text",
"value": "Hello World"
}
],
"depth": 1
}
]
}
SetextHeading#
SetextHeading parses paragraph continuations followed by === or --- as
level 1 or level 2 headings.
Title
-----
Output node is Heading, and its AST is:
{
"type": "root",
"children": [
{
"type": "heading",
"children": [
{
"type": "text",
"value": "Title"
}
],
"depth": 2
}
]
}
Option example: use SetextHeading(transforms=[HeadingIdTransform()]) to add
generated heading IDs.
Hello World
===========
{
"type": "root",
"children": [
{
"type": "heading",
"data": {
"id": "hello-world"
},
"children": [
{
"type": "text",
"value": "Hello World"
}
],
"depth": 1
}
]
}
ThematicBreak#
ThematicBreak parses horizontal rules made from ---, ***, or ___.
---
Output node is ThematicBreak, and its AST is:
{
"type": "root",
"children": [
{
"type": "thematicBreak"
}
]
}
FencedCode#
FencedCode parses fenced code blocks opened by backtick or tilde fences.
```python
print(1)
```
Output node is Code, and its AST is:
{
"type": "root",
"children": [
{
"type": "code",
"value": "print(1)\n",
"lang": "python"
}
]
}
IndentedCode#
IndentedCode parses code blocks indented by four spaces or one tab.
....print(1)
Hint
The above example uses . to represent whitespace.
Output node is Code, and its AST is:
{
"type": "root",
"children": [
{
"type": "code",
"value": "print(1)\n"
}
]
}
HtmlBlock#
HtmlBlock parses CommonMark HTML block starts.
<div>Hi</div>
Output node is Html, and its AST is:
{
"type": "root",
"children": [
{
"type": "html",
"value": "<div>Hi</div>\n"
}
]
}
Option example: use HtmlBlock(disallowed_tags=["script"]) to escape selected
tags during parsing.
<script>alert(1)</script>
{
"type": "root",
"children": [
{
"type": "html",
"data": {
"escaped": true
},
"value": "<script>alert(1)</script>\n"
}
]
}
Blockquote#
Blockquote parses >-prefixed blockquote containers.
> *quote*
Output node is Blockquote, and its AST is:
{
"type": "root",
"children": [
{
"type": "blockquote",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "emphasis",
"children": [
{
"type": "text",
"value": "quote"
}
]
}
]
}
]
}
]
}
List#
List parses bullet and ordered lists.
- *item*
Output nodes are List and ListItem, and their AST is:
{
"type": "root",
"children": [
{
"type": "list",
"children": [
{
"type": "listItem",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "emphasis",
"children": [
{
"type": "text",
"value": "item"
}
]
}
]
}
],
"spread": false
}
],
"ordered": false,
"spread": false
}
]
}
Option example: use List(task=True) to parse GFM task list markers.
- [x] done
- [ ] todo
{
"type": "root",
"children": [
{
"type": "list",
"children": [
{
"type": "listItem",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "done"
}
]
}
],
"checked": true,
"spread": false
},
{
"type": "listItem",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "todo"
}
]
}
],
"checked": false,
"spread": false
}
],
"ordered": false,
"spread": false
}
]
}
Table#
Table parses pipe tables. By default, table body rows must contain an
unescaped pipe; this keeps a following plain paragraph from being padded into
the table body. Use Table(require_body_pipe=False) for GFM-compatible short
body rows, as the github preset does.
| A | B |
| :--- | ---: |
| *x* | y |
Output nodes are Table, TableRow, and TableCell, and their AST is:
{
"type": "root",
"children": [
{
"type": "table",
"children": [
{
"type": "tableRow",
"children": [
{
"type": "tableCell",
"children": [
{
"type": "text",
"value": "A"
}
]
},
{
"type": "tableCell",
"children": [
{
"type": "text",
"value": "B"
}
]
}
]
},
{
"type": "tableRow",
"children": [
{
"type": "tableCell",
"children": [
{
"type": "emphasis",
"children": [
{
"type": "text",
"value": "x"
}
]
}
]
},
{
"type": "tableCell",
"children": [
{
"type": "text",
"value": "y"
}
]
}
]
}
],
"align": [
"left",
"right"
]
}
]
}
Footnote#
Footnote parses inline footnote references and collects matching footnote
definitions with a document-wide transform.
A note[^a].
[^a]: *Footnote*.
Output nodes are FootnoteReference and FootnoteDefinition, and their AST is:
{
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "A note"
},
{
"type": "footnoteReference",
"identifier": "a",
"label": "a"
},
{
"type": "text",
"value": "."
}
]
},
{
"type": "footnoteDefinition",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "emphasis",
"children": [
{
"type": "text",
"value": "Footnote"
}
]
},
{
"type": "text",
"value": "."
}
]
}
],
"identifier": "a",
"label": "a"
}
]
}
LeafDirective#
LeafDirective parses leaf directives such as ::name[label]{attrs}.
::youtube[*Video*]{#abc}
Output node is LeafDirective, and its AST is:
{
"type": "root",
"children": [
{
"type": "leafDirective",
"children": [
{
"type": "emphasis",
"children": [
{
"type": "text",
"value": "Video"
}
]
}
],
"name": "youtube",
"attributes": {
"id": "abc"
}
}
]
}
ContainerDirective#
ContainerDirective parses colon-fenced block directives with optional labels
and attributes.
:::note[Title]{.wide}
*Body*.
:::
Output node is ContainerDirective, and its AST is:
{
"type": "root",
"children": [
{
"type": "containerDirective",
"children": [
{
"type": "paragraph",
"data": {
"directiveLabel": true
},
"children": [
{
"type": "text",
"value": "Title"
}
]
},
{
"type": "paragraph",
"children": [
{
"type": "emphasis",
"children": [
{
"type": "text",
"value": "Body"
}
]
},
{
"type": "text",
"value": "."
}
]
}
],
"name": "note",
"attributes": {
"class": "wide"
}
}
]
}