Typedefs

LinkResolver(String normalizedReference, String reference) Target

Link resolver accepts two references and should return Target with correspondent link. If link doesn't exists link resolver should return null.

Predicate(E argument) → bool

A predicate is a one-argument function that returns a boolean value.

Functions

defaultLinkResolver(String normalizedReference, String reference) Target

Default resolver doesn't return any link, so parser parses only explicitly written references.

markdownToHtml(String markdown, [ Options options ]) → String

Converts markdown string to html string.

Enums

Alignment

Column alignment in table.

BulletType

Bullet type for unordered list

IndexSeparator

Index separator for ordered list

SmartCharType

Type of smart char.

Classes

AstNode

A node in the AST structure for a Markdown file.

AstVisitor

An object that can be used to visit an AST structure.

Attribute

Single attribute in extended attributes.

Attributes

Abstract attributes

Autolink

AutolinkEmail

Autolink email

BaseCompositeInline

Root composite inline node in block nodes.

BaseInline

Root inline node in block nodes.

BlockNode

BlockNode = ThematicBreak | Heading | Blockquote | ListBlock | RawBlock | CodeBlock | Para | LinkReference

Blockquote

Blockquote block

Char

Base class for all simple char inlines.

ClassAttribute

Class attribute in extended attributes ('.' className)

Code

Code inline

CodeBlock

Code block

CompositeInline

Base class for all composite inlines. Also used as top component for inlines list.

Document

Main document object

Emphasis

Emphasis inline

ExtendedAttributes

Extended attributes

HardLineBreak

Hard line break.

Heading

Abstract heading.

HtmlRawBlock

HTML raw block

HtmlRawInline

HTML raw inline

HtmlWriter

Html writer

IdentifierAttribute

Id attribute in extended attributes ('#' + identifier).

Image

Abstract image inline.

InfoString

InfoString attribute (for fenced code only).

InlineImage

Inline image

Inline link

InlineNode

Abstract inline

KeyValueAttribute

Key-value attribute in extended attributes (key '=' value).

Abstract link inline

LinkReference

ListBlock

Abstract list block

ListItem

List item block

MarkdownParser

Main parser class.

NodeList

A list of AST nodes that have a common parent.

NonBreakableSpace

Non-breakable space

Options

Parser or writer options. Mostly contains list of enabled extensions.

OrderedList

Ordered list

Para

Paragraph block

RawBlock

Abstract raw block

RawInline

Abstract raw inline

Reference

Reference.

ReferenceImage

Reference image.

Reference link.

SmartChar

Smart char

SoftLineBreak

Soft line break.

Space

Space char inline

Str

String inline

Strikeout

Strikeout inline

Strong

Strong inline

Subscript

Subscript inline

Superscript

Superscript inline

Tab

Tab char inline

Table

Table block.

TableCell

TableRow

Target

Target ::= TargetLink (' ' TargetTitle)?

TexMath

TexMathDisplay

Display TeX math inline

TexMathInline

Inline TeX Math inline

TexRawBlock

TeX raw block

TexRawInline

ThematicBreak

Thematic break block

UnorderedList

Unordered list

Whitespace

Whitespace char

WithAttributes

Node with extended attributes.

WithExtendedAttributes

Node with extended attributes.

WithReference

Node with reference assigned to it.

WithTarget

Node with target assigned to it.