stig-engine/com.stigway.engine.docs/MarkdownDocument

MarkdownDocument

class MarkdownDocument(val text: String)

Authored page structure and explicit model insertion points, independent of the publishing format.

Constructors

MarkdownDocument

constructor(text: String)

Types

object Companion

data class Heading(val level: Int, val text: String, val range: IntRange)

data class Insertion(val kind: String, val headingLevel: Int, val range: IntRange)

sealed interface Part

Properties

val headings: List<MarkdownDocument.Heading>

val insertions: List<MarkdownDocument.Insertion>

val text: String

val title: MarkdownDocument.Heading?

Functions

fun compose(render: (MarkdownDocument.Insertion) -> String): String

fun destinations(): List<IntRange>

Code examples and commented-out links are not dependencies.

fun parts(): List<MarkdownDocument.Part>

A heading marked {.stig-box .note .open} owns its section; prose is never copied into Kotlin.

renderDokkaHeadings

fun renderDokkaHeadings(): String

Dokka reads heading text and HTML anchors, while MkDocs reads the same attributes directly.

fun renderMkDocs(render: (MarkdownDocument.Insertion) -> String = { error("Model insertion requires a compiled model: ${it.kind}") }): String