Package-level declarations

Types

Link copied to clipboard
object BlankNode : Node

Any unknown node type (should not happen).

Link copied to clipboard
class BlockQuote(val type: BlockQuote.Type? = null, val attribution: InlineContent? = null, val children: List<Node>) : NestableNode

A block quote.

Link copied to clipboard
class Code(val content: String, val language: String?, val showLineNumbers: Boolean = true, val focusedLines: Range? = null) : Node

A code block.

Link copied to clipboard

Creation of a footnote definition, referenceable by a com.quarkdown.core.ast.base.inline.ReferenceFootnote.

Link copied to clipboard
class Heading(val depth: Int, val text: InlineContent, val isDecorative: Boolean = false, val customId: String? = null) : TextNode, Identifiable, LocationTrackableNode

A heading defined via prefix symbols. A heading is identifiable, as it can be looked up in the document and can be referenced. It is also location trackable, meaning its position in the document hierarchy is determined, and possibly displayed.

Link copied to clipboard

A horizontal line (thematic break).

Link copied to clipboard
class Html(val content: String) : Node

An HTML block.

Link copied to clipboard
class LinkDefinition(val label: InlineContent, val url: String, val title: String?) : LinkNode, TextNode

Creation of a referenceable link definition.

Link copied to clipboard
object Newline : Node

A blank line.

Link copied to clipboard
class Paragraph(val text: InlineContent) : TextNode

A general paragraph.

Link copied to clipboard
class Table(val columns: List<Table.Column>, val caption: String? = null) : NestableNode, LocationTrackableNode, CaptionableNode

A table, consisting of columns, each of which has a header and multiple cells. A table is location-trackable since, if requested by the user, it may show a caption displaying its location-based label.

Functions

Link copied to clipboard

Formats the index of this footnote definition according to the numbering format defined in the document, or a default numbering format if none is defined. The default format is 1, 2, 3, ... (decimal numbering).

Link copied to clipboard
Link copied to clipboard

Registers the footnote index of this node within the document handled by context, according to the order of references to it. It is not updated if an index is already set.