Package-level declarations

Types

Link copied to clipboard
object Escape

Utilities for escaping and unescaping strings for various targets.

Link copied to clipboard
sealed interface EscapeTarget

Represents a target (commonly a language or format) that strings can be escaped for.

Link copied to clipboard
object IOUtils

Utility methods for file-based operations.

Link copied to clipboard
sealed interface StringCase

A general purpose strategy to transform a string to a specific case type.

Link copied to clipboard
sealed interface UnescapeTarget

Represents a target (commonly a language or format) that strings can be unescaped from.

Functions

Link copied to clipboard

Transforms this string to a specific case.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Returns a sequence of all nodes in the tree, where this is the root node. The sequence is generated by traversing the tree in depth-first order. The root node is excluded from the sequence.

Link copied to clipboard

Indents each line of this string by indent.

Link copied to clipboard
fun <T> Sequence<T>.iterator(consumeAmount: Int): Iterator<T>
Link copied to clipboard
fun <T> Iterator<T>.nextOrNull(): T?
Link copied to clipboard
fun IntRange.offset(offset: Int): IntRange

Returns a new IntRange with the specified offset added to both the start and end of the range.

Link copied to clipboard
fun String.removeOptionalPrefix(prefix: String, ignoreCase: Boolean = false): Pair<String, Boolean>
Link copied to clipboard
fun StringBuilder.replace(oldValue: String, newValue: String): StringBuilder

An optimized way to replace all occurrences of oldValue with newValue in a StringBuilder.

Link copied to clipboard
Link copied to clipboard

Strips rich content from this inline content and returns a new inline content with only one com.quarkdown.core.ast.base.inline.Text child, which contains the plain text representation of this inline content.

Link copied to clipboard
fun CharSequence.substringWithinBounds(startIndex: Int, endIndex: Int): String
Link copied to clipboard
Link copied to clipboard

Converts processed InlineContent to its plain text representation. For example, the Markdown input foo **bar baz** has foo bar baz as its plain text.

Link copied to clipboard
Link copied to clipboard