kslides-core/com.kslides.slide/MarkdownSlide

MarkdownSlide

Shared contract for slides whose content is authored in Markdown. Implemented by HorizontalMarkdownSlide and VerticalMarkdownSlide.

Members prefixed with private_ are implementation details that cross the slide/renderer boundary; they are not part of the public API and should not be called by user code.

Inheritors

HorizontalMarkdownSlide

VerticalMarkdownSlide

Properties

classes

abstract var classes: String

CSS class list applied to the <section>.

filename

abstract var filename: String

See MarkdownSlide documentation.

abstract var id: String

HTML id applied to the <section>; blank omits the attribute.

private_markdownAssigned

abstract var private_markdownAssigned: Boolean

Implementation detail — true once a content{} block has been supplied.

private_markdownBlock

abstract var private_markdownBlock: () -> String

Implementation detail — do not use.

private_slideId

abstract val private_slideId: Int

Implementation detail — unique slide id, used in renderer diagnostics.

style

abstract var style: String

Inline CSS applied to the <section>; blank omits the attribute.

Functions

content

open fun content(block: () -> String)

Supply inline Markdown content. Mutually exclusive with filename: exactly one of the two must be set before rendering.

include

fun MarkdownSlide.include(src: String, linePattern: String = "", beginToken: String = "", endToken: String = "", exclusive: Boolean = true, trimIndent: Boolean = true, indentToken: String = INDENT_TOKEN): String

include variant for a Markdown slide's content{} block, where reveal.js's Markdown renderer escapes its own output. Unlike CODE.include and DslSlide.include the indent token is kept, since Markdown content is re-indented to match the surrounding block.

processSlide

abstract fun processSlide(section: SECTION)

Apply the slide's attributes to the enclosing <section>. Invoked by the renderer.

slideConfig

abstract fun slideConfig(block: SlideConfig.() -> Unit)

Configure per-slide reveal.js attributes. Implemented by Slide.slideConfig.