API Reference MDEx v#0.12.2

Copy Markdown View Source

Modules

GitHub and GitLab style alerts / admonitions.

Container block directive.

A block quote marker.

Inline code span.

A code block, fenced or indented.

Failed to decode a Document.

Description details of a description item.

A description item of a description list.

A description list.

A description term of a description item.

Document is the core structure to store, manipulate, and render Markdown documents.

Emphasis.

An escaped character.

Escaped tag.

A footnote definition.

The reference to a footnote.

Document metadata.

A heading, either ATX or setext.

Phoenix LiveView HEEx block-level element.

Phoenix LiveView HEEx inline element.

Highlight (mark) text.

A HTML block.

Raw HTML.

An image.

Inserted text.

Given input is invalid.

Invalid Access key selector.

A hard line break.

Link to a URL.

A List that contains MDEx.ListItem.

A List Item of a MDEx.List.

Inline math span.

A multiline block quote.

A paragraph that contains nodes.

A Raw output node. This will be inserted verbatim into CommonMark and HTML output. It can only be created programmatically, and is never parsed from input.

Emoji generated from a shortcode.

Sigils for parsing and formatting Markdown between different formats.

A soft line break.

Source position information for AST nodes.

Spoilered text.

Strikethrough.

Strong emphasis.

Subscript.

Discord-style subtext.

Superscript.

A table with rows and columns.

A table cell inside a table row.

A table row.

A task item inside a list.

Literal text.

A break between lines.

Underline.

A link in the form of a wiki link.