MarkdownSyntax class

Which Markdown extensions are recognized, beyond GitHub-flavored Markdown.

Annotations
  • @immutable

Constructors

MarkdownSyntax({bool dollarMath = true, bool alerts = true, bool citations = true, bool emoji = true, bool highlightAndSpoilers = true, bool inlineHtml = true, bool details = true, bool autolinks = true, Set<String> autolinkSchemes = const {}, List<BlockSyntax> blockSyntaxes = const [], List<InlineSyntax> inlineSyntaxes = const []})
Creates a syntax configuration; everything is on by default.
const

Properties

alerts → bool
GitHub alerts: > [!NOTE], [!TIP], [!IMPORTANT], [!WARNING] and [!CAUTION].
final
Whether bare https:// and www. addresses become links.
final
autolinkSchemes → Set<String>
More schemes to turn into links when written bare, e.g. {'myapp'} for myapp://home. They still have to be allowed by StreamingMarkdown.allowedLinkSchemes to open.
final
blockSyntaxes → List<BlockSyntax>
Your own block syntaxes from package:markdown, tried before the built-in ones. Show what they make with StreamingMarkdown.elementBuilders.
final
citations → bool
[1], [2] after a word become citation chips.
final
details → bool
<details><summary>Title</summary> ... </details> sections.
final
dollarMath → bool
Whether $...$ and $$...$$ are math. \(...\) and \[...\] always are. Turn it off when replies talk about prices a lot.
final
emoji → bool
:rocket: becomes 🚀.
final
hashCode → int
The hash code for this object.
no setteroverride
highlightAndSpoilers → bool
==highlight== and ||spoiler||.
final
inlineHtml → bool
A small set of HTML tags: <sub> <sup> <kbd> <mark> <u> <ins> <small> and <br>. Other HTML shows as text.
final
inlineSyntaxes → List<InlineSyntax>
Your own inline syntaxes from package:markdown, tried before the built-in ones, e.g. for @mentions.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
override