markdown/dev.hirth.markdown/Markdown

Markdown

class Markdown

A DSL for customizing the rendering of Markdown with CommonMark.

Uses the commonmark-java library to parse and render Markdown.

See the CommonMark specification for details on the Markdown syntax, and the different node types.

Constructors

Markdown

constructor()

Functions

attributes

inline fun <T : Node> attributes(crossinline block: CustomAttributes.() -> Unit)

Add a custom attribute provider for the given node type.

fun <T : Node> attributes(vararg clazz: KClass<T>, block: CustomAttributes.() -> Unit)

Add a custom attribute provider for the given node type(s).

block

fun block(block: CustomRenderer<Block>.() -> Unit)

Add a custom renderer for Block nodes.

blockQuote

fun blockQuote(block: CustomRenderer<BlockQuote>.() -> Unit)

Add a custom renderer for BlockQuote node.

bulletList

fun bulletList(block: CustomRenderer<BulletList>.() -> Unit)

Add a custom renderer for BulletList node.

code

fun code(block: CustomRenderer<Code>.() -> Unit)

Add a custom renderer for Code nodes.

config

fun config(block: Config.() -> Unit)

Configure the Markdown parser and renderer.

document

fun document(block: CustomRenderer<Document>.() -> Unit)

Add a custom renderer for Document node.

emphasis

fun emphasis(block: CustomRenderer<Emphasis>.() -> Unit)

Add a custom renderer for Emphasis node.

fencedCodeBlock

fun fencedCodeBlock(block: CustomRenderer<FencedCodeBlock>.() -> Unit)

Add a custom renderer for FencedCodeBlock node.

footnoteDefinition

fun footnoteDefinition(block: CustomRenderer<FootnoteDefinition>.() -> Unit)

Add a custom renderer for FootnoteDefinition node.

footnoteReference

fun footnoteReference(block: CustomRenderer<FootnoteReference>.() -> Unit)

Add a custom renderer for FootnoteReference node.

hardLineBreak

fun hardLineBreak(block: CustomRenderer<HardLineBreak>.() -> Unit)

Add a custom renderer for HardLineBreak node.

heading

fun heading(block: CustomRenderer<Heading>.() -> Unit)

Add a custom renderer for Heading node.

htmlBlock

fun htmlBlock(block: CustomRenderer<HtmlBlock>.() -> Unit)

Add a custom renderer for HtmlBlock node.

htmlInline

fun htmlInline(block: CustomRenderer<HtmlInline>.() -> Unit)

Add a custom renderer for HtmlBlock node.

image

fun image(block: CustomRenderer<Image>.() -> Unit)

Add a custom renderer for HtmlInline node.

imageAttributes

fun imageAttributes(block: CustomRenderer<ImageAttributes>.() -> Unit)

Add a custom renderer for ImageAttributes node.

indentedCodeBlock

fun indentedCodeBlock(block: CustomRenderer<IndentedCodeBlock>.() -> Unit)

Add a custom renderer for HtmlInline node.

ins

fun ins(block: CustomRenderer<Ins>.() -> Unit)

Add a custom renderer for Ins node.

link

fun link(block: CustomRenderer<Link>.() -> Unit)

Add a custom renderer for Link node.

linkReferenceDefinition

fun linkReferenceDefinition(block: CustomRenderer<LinkReferenceDefinition>.() -> Unit)

Add a custom renderer for LinkReferenceDefinition node.

listBlock

fun listBlock(block: CustomRenderer<ListBlock>.() -> Unit)

Add a custom renderer for ListBlock node.

listItem

fun listItem(block: CustomRenderer<ListItem>.() -> Unit)

Add a custom renderer for ListItem node.

orderedList

fun orderedList(block: CustomRenderer<OrderedList>.() -> Unit)

Add a custom renderer for OrderedList node.

paragraph

fun paragraph(block: CustomRenderer<Paragraph>.() -> Unit)

Add a custom renderer for Paragraph node.

parser

fun parser(block: Parser.Builder.() -> Unit)

Customize the Markdown parser.

render

fun <T : Node> render(vararg clazz: KClass<T>, block: CustomRenderer<Node>.() -> Unit)

Add a custom renderer for the given node type(s).

renderer

fun renderer(block: HtmlRenderer.Builder.() -> Unit)

Customize the Markdown renderer.

softLineBreak

fun softLineBreak(block: CustomRenderer<SoftLineBreak>.() -> Unit)

Add a custom renderer for SoftLineBreak node.

strikethrough

fun strikethrough(block: CustomRenderer<Strikethrough>.() -> Unit)

Add a custom renderer for Strikethrough node.

strongEmphasis

fun strongEmphasis(block: CustomRenderer<StrongEmphasis>.() -> Unit)

Add a custom renderer for StrongEmphasis node.

tableBlock

fun tableBlock(block: CustomRenderer<TableBlock>.() -> Unit)

Add a custom renderer for TableBlock node.

tableBody

fun tableBody(block: CustomRenderer<TableBody>.() -> Unit)

Add a custom renderer for TableBody node.

tableCell

fun tableCell(block: CustomRenderer<TableCell>.() -> Unit)

Add a custom renderer for TableCell node.

tableHead

fun tableHead(block: CustomRenderer<TableHead>.() -> Unit)

Add a custom renderer for TableHead node.

tableRow

fun tableRow(block: CustomRenderer<TableRow>.() -> Unit)

Add a custom renderer for TableRow node.

taskListItemMarker

fun taskListItemMarker(block: CustomRenderer<TaskListItemMarker>.() -> Unit)

Add a custom renderer for TaskListItemMarker node.

text

fun text(block: CustomRenderer<Text>.() -> Unit)

Add a custom renderer for Text node.

thematicBreak

fun thematicBreak(block: CustomRenderer<ThematicBreak>.() -> Unit)

Add a custom renderer for ThematicBreak node.

visitor

fun visitor(visitor: Visitor)

Add a custom visitor.

yamlFrontMatterBlock

fun yamlFrontMatterBlock(block: CustomRenderer<YamlFrontMatterBlock>.() -> Unit)

Add a custom renderer for YamlFrontMatterBlock node.

yamlFrontMatterNode

fun yamlFrontMatterNode(block: CustomRenderer<YamlFrontMatterNode>.() -> Unit)

Add a custom renderer for YamlFrontMatterNode node.