markdown/dev.hirth.markdown

Package-level declarations

Types

data class Config(var enableAutolink: Boolean = false, var enableStrikethrough: Boolean = false, var enableTables: Boolean = false, var enableFootnotes: Boolean = false, var enableHeadingAnchors: Boolean = false, var enableIns: Boolean = false, var enableYamlFrontMatter: Boolean = false, var enableImageAttributes: Boolean = false, var enableTaskList: Boolean = false)

Configuration of Markdown extensions.

CustomAttributes

class CustomAttributes(val node: Node, val tag: String, val attrs: MutableMap<String, String>)

CustomRenderer

class CustomRenderer<T : Node>(val node: T, val ctx: HtmlNodeRendererContext)

Markdown

class Markdown

A DSL for customizing the rendering of Markdown with CommonMark.

Rendered

data class Rendered(val html: String, val metadata: Map<String, List<String>>?)

Functions

renderMarkdown

fun renderMarkdown(md: String, block: Markdown.() -> Unit): Rendered

Render the Markdown string md, using the given block to configure the commonmark rendering.