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

Constants

commonmark Options

Predefined version of Options. Alongside with strict also supports smart puctuation, which is declared separately in CommonMark.

const Options(smartPunctuation: true)
defaults Options

Predefined version of Options. Enables lot of useful extensions.

const Options(smartPunctuation: true, fencedCodeAttributes: true, headingAttributes: true, inlineCodeAttributes: true, linkAttributes: true, strikeout: t…
strict Options

Predefined strict version of Options. Only support CommonMark specification.

const Options()

Constructors

Options({bool rawHtml: true, bool smartPunctuation: false, bool fencedCodeAttributes: false, bool headingAttributes: false, bool inlineCodeAttributes: false, bool linkAttributes: false, bool strikeout: false, bool subscript: false, bool superscript: false, bool texMathDollars: false, bool texMathSingleBackslash: false, bool texMathDoubleBackslash: false, bool rawTex: false, bool pipeTables: false, Iterable<String> inlineTexMathClasses: const ['math', 'inline'], Iterable<String> displayTexMathClasses: const ['math', 'display'], LinkResolver linkResolver: defaultLinkResolver })

Constant constructor with required options.

const

Properties

displayTexMathClasses → Iterable<String>

Classes added to span on rendering display math into html. Defaults to ['math', 'display'].

read-only
fencedCodeAttributes → bool

Allows fenced code block to have arbitrary extended attributes.

read-only
hashCode → int

Get a hash code for this object.

read-only, inherited
headingAttributes → bool

Allows headings to have arbitrary extended attributes.

read-only
inlineCodeAttributes → bool

Adds extended attributes support to inline code.

read-only
inlineTexMathClasses → Iterable<String>

Classes added to span on rendering inline math into html. Defaults to ['math', 'inline'].

read-only
linkAttributes → bool

Extended attributes for links and images. Both inline and reference links are supported.

read-only
linkResolver LinkResolver

Custom reference resolver may be required when parsing document without implicit defined references, for example Dartdoc.

read-only
pipeTables → bool

read-only
rawHtml → bool

Enables raw html blocks and inlines. This officially supported extension from Commonmart and thus requires explicit disabling.

read-only
rawTex → bool

Enables raw TeX blocks.

read-only
runtimeType → Type

A representation of the runtime type of the object.

read-only, inherited
smartPunctuation → bool

Enables smart punctuation extension. It's automatic replacement of ..., ---, --, " and ' to …, —, – and curly versions of quote marks accordingly. It's only official extension to date.

read-only
strikeout → bool

Enables strikeout extension. Strikeout is a text wrapped with double tilde (~~). Example:

read-only
subscript → bool

Enables subscript extension. Subscript is a text wrapped with tilde (~). Example:

read-only
superscript → bool

Enables superscript extension. Superscript is a text wrapped with caret (^). Example:

read-only
texMathDollars → bool

Enables tex math inside $ or $$.

read-only
texMathDoubleBackslash → bool

Causes anything between \\( and \\) to be interpreted as inline TeX math, and anything between \\[ and \\] to be interpreted as display TeX math.

read-only
texMathSingleBackslash → bool

Causes anything between \( and \) to be interpreted as inline TeX math, and anything between \[ and \] to be interpreted as display TeX math.

read-only

Operators

operator ==(other) → bool

The equality operator.

inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a non-existent method or property is accessed.

inherited
toString() → String

Returns a string representation of this object.

inherited