markdown/com.varabyte.kobwebx.gradle.markdown.handlers/MarkdownHandlers

MarkdownHandlers

abstract class MarkdownHandlers @Inject constructor(project: Project)(source)

For example, if your project declares a fancy, custom horizontal rule, you can register it like so:

kobweb {
  markdown {
    handlers {
      hr.set { "com.myproject.components.widgets.FancyRule()" }
    }
  }
}

Constructors

MarkdownHandlers

@Inject

constructor(project: Project)

Types

DataKeys

object DataKeys

Keys which can be used to read/write data values into/out of the NodeScope.data container.

ImageData

class ImageData(val destination: String, val altText: String, val title: String?)

Data pulled out of an Image node into an easier-to-consume format.

Properties

abstract val a: Property<NodeScope.(Link) -> String>

blockquote

abstract val blockquote: Property<NodeScope.(BlockQuote) -> String>

abstract val br: Property<NodeScope.(HardLineBreak) -> String>

code

abstract val code: Property<NodeScope.(FencedCodeBlock) -> String>

abstract val em: Property<NodeScope.(Emphasis) -> String>

generateHeaderIds

@get:Input

abstract val generateHeaderIds: Property<Boolean>

If true, attach an auto-generated header ID to each header element.

heading

abstract val heading: Property<NodeScope.(Heading) -> String>

abstract val hr: Property<NodeScope.(ThematicBreak) -> String>

html

abstract val html: Property<NodeScope.(HtmlBlock) -> String>

idGenerator

abstract val idGenerator: Property<(String) -> String>

Handler for converting some incoming text (fairly unconstrained) into a final string value that should be used as an ID for a URL fragment.

img

abstract val img: Property<NodeScope.(Image) -> String>

inlineCode

abstract val inlineCode: Property<NodeScope.(Code) -> String>

inlineTag

abstract val inlineTag: Property<NodeScope.(HtmlInline) -> String>

abstract val li: Property<NodeScope.(ListItem) -> String>

abstract val ol: Property<NodeScope.(OrderedList) -> String>

abstract val p: Property<NodeScope.(Paragraph) -> String>

rawTag

abstract val rawTag: Property<NodeScope.(String) -> String>

Handler which is fed the raw text (name and attributes) within an opening tag, e.g. span id="demo"

strong

abstract val strong: Property<NodeScope.(StrongEmphasis) -> String>

table

abstract val table: Property<NodeScope.(TableBlock) -> String>

tbody

abstract val tbody: Property<NodeScope.(TableBody) -> String>

abstract val td: Property<NodeScope.(TableCell) -> String>

text

abstract val text: Property<NodeScope.(Text) -> String>

abstract val th: Property<NodeScope.(TableCell) -> String>

thead

abstract val thead: Property<NodeScope.(TableHead) -> String>

abstract val tr: Property<NodeScope.(TableRow) -> String>

abstract val ul: Property<NodeScope.(BulletList) -> String>

useSilk

@get:Input

abstract val useSilk: Property<Boolean>

Use Silk components instead of Compose HTML components when relevant.

Functions

escapeSingleQuotedText

fun String.escapeSingleQuotedText(): String

escapeTripleQuotedText

fun String.escapeTripleQuotedText(): String

processImage

fun NodeScope.processImage(image: Image, output: (MarkdownHandlers.ImageData) -> String): String

Helper function to process an Image node, passing information to a callback to generate the final output.