kslides

fun kslides(block: KSlides.() -> Unit): KSlides

Top-level entry point for defining presentations.

A typical script looks like:

kslides {
output { enableFileSystem = true; enableHttp = false }
presentation {
path = "helloworld.html"
markdownSlide { content { "# Hello" } }
}
}

On return, the configured output modes are executed: enableFileSystem writes static HTML under the output directory, and enableHttp starts a Ktor server on the configured port. If neither is enabled, a warning is logged and no slides are emitted.

Return

the populated KSlides instance (primarily useful for tests).

Parameters

block

configuration block applied to a fresh KSlides instance.

Throws

if no KSlides.presentation blocks are declared, or if any presentation contains zero slides.