1.8.0

quarkdown-core/com.quarkdown.core.ast.base.inline

Package-level declarations

Types

class CheckBox(val isChecked: Boolean) : Node

An immutable checkbox that is either checked or unchecked.

class CodeSpan(val text: String, val content: CodeSpan.ContentInfo? = null) : PlainTextNode

Inline code.

object Comment : Node

A comment whose content is ignored.

CriticalContent

class CriticalContent(val text: String) : PlainTextNode

Content (usually a single character) that requires special treatment during the rendering stage.

class Emphasis(val text: InlineContent) : TextNode

Weakly emphasized content.

class Image(val link: LinkNode, val width: Size?, val height: Size?) : Node

An image.

object LineBreak : Node

A hard line break.

class Link(val label: InlineContent, val url: String, val title: String?) : LinkNode, TextNode

A link.

interface PlainTextNode : Node

A Node that contains plain text.

ReferenceDefinitionFootnote

class ReferenceDefinitionFootnote(val label: String, val definition: InlineContent) : NestableNode

An all-in-one ReferenceFootnote that includes its FootnoteDefinition.

ReferenceFootnote

class ReferenceFootnote(val label: String, val fallback: () -> Node) : ReferenceNode<ReferenceFootnote, FootnoteDefinition>

A reference to a com.quarkdown.core.ast.base.block.FootnoteDefinition.

class ReferenceImage(val link: ReferenceLink, val width: Size?, val height: Size?) : Node

An images that references a LinkDefinition.

class ReferenceLink(val label: InlineContent, val reference: InlineContent, val fallback: () -> Node, val onResolve: MutableList<(resolved: LinkNode) -> Unit> = mutableListOf()) : Node

A link that references a LinkDefinition.

class Strikethrough(val text: InlineContent) : TextNode

Strikethrough content.

class Strong(val text: InlineContent) : TextNode

Strongly emphasized content.

class StrongEmphasis(val text: InlineContent) : TextNode

Heavily emphasized content.

SubdocumentLink

class SubdocumentLink(val link: Link) : LinkNode, TextNode

A link to a Quarkdown subdocument.

SubdocumentProperty

data class SubdocumentProperty(val value: Subdocument) : Property<Subdocument>

A property that holds a reference to a Subdocument associated with a SubdocumentLink during the tree traversal stage.

class Text(val text: String) : PlainTextNode

Plain inline text.

Functions

fun SubdocumentLink.getSubdocument(context: Context): Subdocument?

fun SubdocumentLink.setSubdocument(context: MutableContext, subdocument: Subdocument)

Associates a Subdocument with the SubdocumentLink in the given context.