Markdown Abstract Syntax Tree.
MDAST discloses markdown as an abstract syntax tree. Abstract means not all information is stored in this tree and an exact replica of the original document cannot be re-created. Syntax Tree means syntax is present in the tree, thus an exact syntactic document can be re-created.
MDAST is a subset of unist, and implemented by remark.
This document describes version 2.0.0 of MDAST. Changelog ».
Root (Parent) houses all nodes.
interface Root <: Parent {
type: "root";
}Paragraph (Parent) represents a unit of discourse dealing
with a particular point or idea.
interface Paragraph <: Parent {
type: "paragraph";
}For example, the following markdown:
Alpha bravo charlie.Yields:
{
"type": "paragraph",
"children": [{
"type": "text",
"value": "Alpha bravo charlie."
}]
}Blockquote (Parent) represents a quote.
interface Blockquote <: Parent {
type: "blockquote";
}For example, the following markdown:
> Alpha bravo charlie.Yields:
{
"type": "blockquote",
"children": [{
"type": "paragraph",
"children": [{
"type": "text",
"value": "Alpha bravo charlie."
}]
}]
}Heading (Parent), just like with HTML, with a level greater
than or equal to 1, lower than or equal to 6.
interface Heading <: Parent {
type: "heading";
depth: 1 <= uint32 <= 6;
}For example, the following markdown:
# AlphaYields:
{
"type": "heading",
"depth": 1,
"children": [{
"type": "text",
"value": "Alpha"
}]
}Code (Text) occurs at block level (see
InlineCode for code spans). Code sports a language
tag (when using GitHub Flavoured Markdown fences with a flag, null
otherwise).
interface Code <: Text {
type: "code";
lang: string | null;
}For example, the following markdown:
foo()Yields:
{
"type": "code",
"lang": null,
"value": "foo()"
}InlineCode (Text) occurs inline (see Code for
blocks). Inline code does not sport a lang attribute.
interface InlineCode <: Text {
type: "inlineCode";
}For example, the following markdown:
`foo()`Yields:
{
"type": "inlineCode",
"value": "foo()"
}YAML (Text) can occur at the start of a document, and
contains embedded YAML data.
interface YAML <: Text {
type: "yaml";
}For example, the following markdown:
---
foo: bar
---Yields:
{
"type": "yaml",
"value": "foo: bar"
}HTML (Text) contains embedded HTML.
interface HTML <: Text {
type: "html";
}For example, the following markdown:
<div>Yields:
{
"type": "html",
"value": "<div>"
}List (Parent) contains ListItems.
The start property contains the starting number of the list when
ordered: true; null otherwise.
When all list items have loose: false, the list’s loose property is also
false. Otherwise, loose: true.
interface List <: Parent {
type: "list";
ordered: true | false;
start: uint32 | null;
loose: true | false;
}For example, the following markdown:
1. [x] fooYields:
{
"type": "list",
"ordered": true,
"start": 1,
"loose": false,
"children": [{
"type": "listItem",
"loose": false,
"checked": true,
"children": [{
"type": "paragraph",
"children": [{
"type": "text",
"value": "foo",
}]
}]
}]
}ListItem (Parent) is a child of a List.
Loose ListItems often contain more than one block-level elements.
A checked property exists on ListItems, set to true (when checked),
false (when unchecked), or null (when not containing a checkbox).
See Task Lists on GitHub for information.
interface ListItem <: Parent {
type: "listItem";
loose: true | false;
checked: true | false | null;
}For an example, see the definition of List.
Table (Parent) represents tabular data, with alignment.
Its children are TableRows, the first of which acts as
a table header row.
table.align represents the alignment of columns.
interface Table <: Parent {
type: "table";
align: [alignType];
}enum alignType {
"left" | "right" | "center" | null;
}For example, the following markdown:
| foo | bar |
| :-- | :-: |
| baz | qux |Yields:
{
"type": "table",
"align": ["left", "center"],
"children": [
{
"type": "tableRow",
"children": [
{
"type": "tableCell",
"children": [{
"type": "text",
"value": "foo"
}]
},
{
"type": "tableCell",
"children": [{
"type": "text",
"value": "bar"
}]
}
]
},
{
"type": "tableRow",
"children": [
{
"type": "tableCell",
"children": [{
"type": "text",
"value": "baz"
}]
},
{
"type": "tableCell",
"children": [{
"type": "text",
"value": "qux"
}]
}
]
}
]
}TableRow (Parent). Its children are always
TableCell.
interface TableRow <: Parent {
type: "tableRow";
}For an example, see the definition of Table.
TableCell (Parent). Contains a single tabular field.
interface TableCell <: Parent {
type: "tableCell";
}For an example, see the definition of Table.
A ThematicBreak (Node) represents a break in content,
often shown as a horizontal rule, or by two HTML section elements.
interface ThematicBreak <: Node {
type: "thematicBreak";
}For example, the following markdown:
***Yields:
{
"type": "thematicBreak"
}Break (Node) represents an explicit line break.
interface Break <: Node {
type: "break";
}For example, the following markdown (interpuncts represent spaces):
foo··
barYields:
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "foo"
},
{
"type": "break"
},
{
"type": "text",
"value": "bar"
}
]
}Emphasis (Parent) represents slight emphasis.
interface Emphasis <: Parent {
type: "emphasis";
}For example, the following markdown:
*alpha* _bravo_Yields:
{
"type": "paragraph",
"children": [
{
"type": "emphasis",
"children": [{
"type": "text",
"value": "alpha"
}]
},
{
"type": "text",
"value": " "
},
{
"type": "emphasis",
"children": [{
"type": "text",
"value": "bravo"
}]
}
]
}Strong (Parent) represents strong emphasis.
interface Strong <: Parent {
type: "strong";
}For example, the following markdown:
**alpha** __bravo__Yields:
{
"type": "paragraph",
"children": [
{
"type": "strong",
"children": [{
"type": "text",
"value": "alpha"
}]
},
{
"type": "text",
"value": " "
},
{
"type": "strong",
"children": [{
"type": "text",
"value": "bravo"
}]
}
]
}Delete (Parent) represents text ready for removal.
interface Delete <: Parent {
type: "delete";
}For example, the following markdown:
~~alpha~~Yields:
{
"type": "delete",
"children": [{
"type": "text",
"value": "alpha"
}]
}Link (Parent) represents the humble hyperlink.
interface Link <: Parent {
type: "link";
title: string | null;
url: string;
}For example, the following markdown:
[alpha](http://example.com "bravo")Yields:
{
"type": "link",
"title": "bravo",
"url": "http://example.com",
"children": [{
"type": "text",
"value": "alpha"
}]
}Image (Node) represents the figurative figure.
interface Image <: Node {
type: "image";
title: string | null;
alt: string | null;
url: string;
}For example, the following markdown:
Yields:
{
"type": "image",
"title": "bravo",
"url": "http://example.com",
"alt": "alpha"
}Footnote (Parent) represents an inline marker, whose
content relates to the document but is outside its flow.
interface Footnote <: Parent {
type: "footnote";
}For example, the following markdown:
[^alpha bravo]Yields:
{
"type": "footnote",
"children": [{
"type": "text",
"value": "alpha bravo"
}]
}LinkReference (Parent) represents a humble hyperlink,
its url and title defined somewhere else in the document by a
Definition.
referenceType is needed to detect if a reference was meant as a
reference ([foo][]) or just unescaped brackets ([foo]).
interface LinkReference <: Parent {
type: "linkReference";
identifier: string;
referenceType: referenceType;
}enum referenceType {
"shortcut" | "collapsed" | "full";
}For example, the following markdown:
[alpha][bravo]Yields:
{
"type": "linkReference",
"identifier": "bravo",
"referenceType": "full",
"children": [{
"type": "text",
"value": "alpha"
}]
}ImageReference (Node) represents a figurative figure,
its url and title defined somewhere else in the document by a
Definition.
referenceType is needed to detect if a reference was meant as a
reference (![foo][]) or just unescaped brackets (![foo]).
See LinkReference for the definition of referenceType.
interface ImageReference <: Node {
type: "imageReference";
identifier: string;
referenceType: referenceType;
alt: string | null;
}For example, the following markdown:
![alpha][bravo]Yields:
{
"type": "imageReference",
"identifier": "bravo",
"referenceType": "full",
"alt": "alpha"
}FootnoteReference (Node) is like Footnote,
but its content is already outside the documents flow: placed in a
FootnoteDefinition.
interface FootnoteReference <: Node {
type: "footnoteReference";
identifier: string;
}For example, the following markdown:
[^alpha]Yields:
{
"type": "footnoteReference",
"identifier": "alpha"
}Definition (Node) represents the definition (i.e., location
and title) of a LinkReference or an
ImageReference.
interface Definition <: Node {
type: "definition";
identifier: string;
title: string | null;
url: string;
}For example, the following markdown:
[alpha]: http://example.comYields:
{
"type": "definition",
"identifier": "alpha",
"title": null,
"url": "http://example.com"
}FootnoteDefinition (Parent) represents the definition
(i.e., content) of a FootnoteReference.
interface FootnoteDefinition <: Parent {
type: "footnoteDefinition";
identifier: string;
}For example, the following markdown:
[^alpha]: bravo and charlie.Yields:
{
"type": "footnoteDefinition",
"identifier": "alpha",
"children": [{
"type": "paragraph",
"children": [{
"type": "text",
"value": "bravo and charlie."
}]
}]
}TextNode (Text) represents everything that is just text.
Note that its type property is text, but it is different from
Text.
interface TextNode <: Text {
type: "text";
}For example, the following markdown:
Alpha bravo charlie.Yields:
{
"type": "text",
"value": "Alpha bravo charlie."
}wooorm/mdast-util-assert— Assert MDAST nodes;wooorm/mdast-comment-marker— Parse a comment marker;wooorm/mdast-util-compact— Make an MDAST tree compact;wooorm/mdast-util-definitions— Find definition nodes;wooorm/mdast-util-heading-range— Markdown heading as ranges;wooorm/mdast-util-heading-style— Get the style of a heading node;anandthakker/mdast-util-inject— Inject a tree into another at a given heading;wooorm/mdast-util-to-string— Get the plain text content of a node;eush77/mdast-normalize-headings— Ensure at most one top-level heading is in the document;eush77/mdast-squeeze-paragraphs— Remove empty paragraphs;BarryThePenguin/mdast-util-toc— Generate a Table of Contents from a tree;wooorm/mdast-util-to-hast— Transform MDAST to HAST;wooorm/mdast-util-to-nlcst— Transform MDAST to NLCST;wooorm/mdast-zone— HTML comments as ranges or markers.
MIT © Titus Wormer
