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

Package-level declarations

Types

Any unknown node type (should not happen).

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

A block quote.

Code

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

A code block.

Heading

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.

HorizontalRule

object HorizontalRule : Node

A horizontal line (thematic break).

Html

class Html(val content: String) : Node

An HTML block.

LinkDefinition

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

Creation of a link reference.

Newline

object Newline : Node

A blank line.

Paragraph

class Paragraph(val text: InlineContent) : TextNode

A general paragraph.

Table

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.