Package-level declarations

Types

Link copied to clipboard
class BlockCodeToken(data: TokenData, val content: String) : Token

Example:

Link copied to clipboard
class BlockQuoteToken(data: TokenData, val content: String) : Token

Example:

Link copied to clipboard
Link copied to clipboard
class CodeSpanToken(data: TokenData, val content: String) : Token

Examples:

Link copied to clipboard

Example:

Link copied to clipboard

A character that requires special treatment during the rendering stage. Examples: &, <, >, ", ', ...

Link copied to clipboard
class DiamondAutolinkToken(data: TokenData, val url: String) : Token

Example:

Link copied to clipboard
class EmphasisToken(data: TokenData, val children: List<Token>) : Token

Examples:

Link copied to clipboard
class EntityToken(data: TokenData, val body: String, val numeric: String?) : Token

An entity reference character. Examples: &nbsp;, &amp;, &copy;, '#', &#x22, ...

Link copied to clipboard
class EscapeToken(data: TokenData, val character: String) : Token

An escaped character. Examples: \#, \>, ...

Link copied to clipboard
class FencesCodeToken(data: TokenData, val indent: Int, val language: String?, val caption: String?, val customId: String?, val content: String) : Token

Examples:

Link copied to clipboard
class FootnoteDefinitionToken(data: TokenData, val label: String, val content: String) : Token

Example:

Link copied to clipboard
class FunctionCallToken(data: TokenData, val isBlock: Boolean, val walkerResult: WalkerParsingResult<WalkedFunctionCall>) : Token

A function call token, produced by the lexer's walker subsystem. This is a custom Quarkdown element, and is both a block and inline node.

Link copied to clipboard
class HeadingToken(data: TokenData, val depth: Int, val isDecorative: Boolean, val content: String, val customId: String?) : Token

Example:

Link copied to clipboard

A thematic break. Examples:

Link copied to clipboard
class HtmlToken(data: TokenData) : Token

Example:

Link copied to clipboard
class ImageToken(data: TokenData, val label: String, val url: String, val title: String?, val width: String?, val height: String?, val customId: String?) : Token

Example:

Link copied to clipboard
class InlineMathToken(data: TokenData, val expression: String) : Token

A one-line fenced block that contains a TeX expression. If it's isolated, then it's a OnelineMathToken. This is a Quarkdown extension.

Link copied to clipboard
class LineBreakToken(data: TokenData, val isHard: Boolean) : Token

A line break. Example:

Link copied to clipboard
class LinkDefinitionToken(data: TokenData, val label: String, val url: String, val title: String?) : Token

Example:

Link copied to clipboard
class LinkToken(data: TokenData, val label: String, val url: String, val title: String?) : Token

Example:

Link copied to clipboard
class ListItemToken(data: TokenData, val marker: String, val task: String) : Token

Examples:

Link copied to clipboard
class MultilineMathToken(data: TokenData, val expression: String, val customId: String?) : Token

A multiline fenced block that contains a TeX expression. This is a custom Quarkdown block.

Link copied to clipboard

A blank line.

Link copied to clipboard
class OnelineMathToken(data: TokenData, val expression: String, val customId: String?) : Token

An isolated one-line fenced block that contains a TeX expression. If it's not isolated, then it's an InlineMathToken. This is a custom Quarkdown block.

Link copied to clipboard
class OrderedListToken(data: TokenData, val marker: String) : Token

Example:

Link copied to clipboard

A page break. This is a custom Quarkdown block.

Link copied to clipboard
Link copied to clipboard

Text content.

Link copied to clipboard
class ReferenceFootnoteToken(data: TokenData, val label: String, val definition: String?) : Token

Examples:

Link copied to clipboard
class ReferenceImageToken(data: TokenData, val label: String, val reference: String?, val width: String?, val height: String?, val customId: String?) : Token

Examples:

Link copied to clipboard
class ReferenceLinkToken(data: TokenData, val label: String, val reference: String?) : Token

Examples:

Link copied to clipboard
class SetextHeadingToken(data: TokenData, val content: String, val underline: String, val customId: String?) : Token

Examples:

Link copied to clipboard
class StrikethroughToken(data: TokenData, val children: List<Token>) : Token

Example:

Link copied to clipboard
class StrongEmphasisToken(data: TokenData, val children: List<Token>) : Token

Examples:

Link copied to clipboard
class StrongToken(data: TokenData, val children: List<Token>) : Token

Examples:

Link copied to clipboard
class TableToken(data: TokenData, val header: String, val alignment: String, val rows: String) : Token

Examples:

Link copied to clipboard

A sequence of characters that is replaced with a symbol (e.g. (C) -> ©). This is a Quarkdown extension.

Link copied to clipboard

Example:

Link copied to clipboard

GFM extension. Example: