0.1.0

prompt-markdown/ai.koog.prompt.markdown/MarkdownContentBuilder

MarkdownContentBuilder

class MarkdownContentBuilder : TextContentBuilder(source)

A dedicated builder for creating markdown content. Wraps TextContentBuilder and provides markdown-specific functionality for generating well-formatted Markdown documents programmatically.

Example usage:

val document = markdown {
    h1("Hello, Markdown!")
    +"This is a paragraph of text."

    h2("Features")
    bulleted {
        item("Easy to use")
        item("Type-safe")
        item("Extensible")
    }

    link("Learn more", "https://example.com")
}

Constructors

MarkdownContentBuilder

constructor()

Types

class LineContext(builder: TextContentBuilder = TextContentBuilder())

Context for building a single line of markdown with mixed formatting elements. Used within the line method to create complex inline formatting.

inner class ListContext(bullet: (counter: Int) -> String)

Context for building structured lists (bulleted, numbered).

Properties

val caret: TextContentBuilder.Caret

Functions

fun blockquote(text: String)

Adds a blockquote to the content.

fun bold(text: String)

Adds a bold text (text) to the content.

fun br()

fun build(): String

fun bulleted(block: MarkdownContentBuilder.ListContext.() -> Unit)

Adds a bulleted list with a block structure.

fun code(code: String)

Adds a code span (code) to the content.

fun codeblock(code: String, language: String = "")

Adds a code block with optional language specification to the content.

fun h1(text: String)

Adds a level 1 header (# Header) to the content.

fun h2(text: String)

Adds a level 2 header (## Header) to the content.

fun h3(text: String)

Adds a level 3 header (### Header) to the content.

fun h4(text: String)

Adds a level 4 header (#### Header) to the content.

fun h5(text: String)

Adds a level 5 header (##### Header) to the content.

fun h6(text: String)

Adds a level 6 header (###### Header) to the content.

fun header(level: Int, text: String)

Adds a markdown header to the content.

fun horizontalRule()

Adds a horizontal rule (---) to the content.

fun image(alt: String, url: String)

Adds an image () to the content.

fun italic(text: String)

Adds an italic text (text) to the content.

fun line(block: MarkdownContentBuilder.LineContext.() -> Unit)

Creates a single line of markdown content with mixed formatting. Useful for creating complex inline formatting combinations.

fun link(text: String, url: String)

Adds a link (text) to the content.

inline fun TextContentBuilder.markdown(init: MarkdownContentBuilder.() -> Unit)

Extension function to add markdown content to a TextContentBuilder.

operator fun String.not()

fun numbered(block: MarkdownContentBuilder.ListContext.() -> Unit)

Adds a numbered list with a block structure.

fun padding(padding: String, body: TextContentBuilder.() -> Unit)

fun strikethrough(text: String)

Adds a strikethrough text (~~text~~) to the content.

fun table(headers: List<String>, rows: List<List<String>>, alignments: List<TableAlignment> = List(headers.size) { TableAlignment.LEFT })

Adds a table to the content.

fun text(text: String)

textWithNewLine

fun textWithNewLine(text: String)

open operator fun String.unaryPlus()