markdown/parsek.markdown.parser

Package-level declarations

Types

BlockQuoteStrip

data class BlockQuoteStrip(val innerLine: Line)

BulletStrip

data class BulletStrip(val marker: Char, val innerLine: Line, val contentIndent: Int)

Line

data class Line(val lexemes: List<Lexeme>, val text: String, val lazy: Boolean = false)

A raw line of lexemes with its original text for convenience.

LinkRefDef

data class LinkRefDef(val label: String, val destination: String, val title: String?)

A parsed link reference definition.

LinkRefResolver

typealias LinkRefResolver = (label: String) -> Pair<String, String?>?

Resolves a link reference label to (destination, title?) or null.

ListItemResult

data class ListItemResult(val item: Block.ListItem, val nextIndex: Int, val blankAfter: Boolean, val containsBlank: Boolean)

Result of collecting a list item.

OrderedStrip

data class OrderedStrip(val number: Int, val delimiter: Char, val innerLine: Line, val contentIndent: Int)

Properties

HTML5_ENTITIES

val HTML5_ENTITIES: Map<String, String>

HTML5 named character references. Generated from https://html.spec.whatwg.org/entities.json Keys are entity names WITHOUT leading & and trailing ;.

Functions

parseBlocks

fun parseBlocks(tokens: List<Token>): List<Block>

Block parser: converts a list of block-level Tokens into Block AST nodes.

parseDocument

fun parseDocument(text: String, gfm: Boolean = true): MarkdownDocument

Parses a markdown string into a MarkdownDocument AST.

parseInlines

fun parseInlines(text: String, resolveRef: LinkRefResolver? = null): List<Inline>

Parses inline markdown content from raw text into a list of Inline nodes.

parseLines

fun parseLines(lines: List<Line>): List<Block>

Parses a list of lines into block AST nodes. This is the main recursive entry point — container blocks call this on their inner content.

parseLinkRefDefs

fun parseLinkRefDefs(text: String): Pair<List<LinkRefDef>, String>

Extracts leading link reference definitions from paragraph text. Returns the list of definitions found plus the remaining text. CommonMark §4.7: [label]: destination "title"

tryStripBlockQuoteMarker

fun tryStripBlockQuoteMarker(line: Line): BlockQuoteStrip?

Tries to strip a block quote marker (> + optional space) from a line.

tryStripBulletMarker

fun tryStripBulletMarker(line: Line): BulletStrip?

Tries to strip a bullet list marker (-, +, *) from a line.

tryStripOrderedMarker

fun tryStripOrderedMarker(line: Line): OrderedStrip?

Tries to strip an ordered list marker (digits + . or )) from a line.