Reading

class Reading(source: String, dialect: Dialect = Dialect())(source)

Answers dialect questions about a commonmark tree and its original source.

Constructors

constructor(source: String, dialect: Dialect = Dialect())

val document: Node

The lazily parsed document for this reader's source.

fun calloutClass(quote: BlockQuote): String?

Returns the class of a quote accepted as a callout at its position.

Returns marked quotes the dialect declined to turn into constructs.

fun opensAConstruct(quote: BlockQuote): Boolean

Returns whether the quote starts with any marker known to the dialect.

fun place(quote: BlockQuote): Found?

Returns the placed map represented by a quote.

Returns dialect constructs in document order.

fun unreadable(quote: BlockQuote): String?

Returns the source-preserving words of an out-of-bounds map.