reveal-kt1.3.0
Craft elegant Reveal.js presentations with pure Kotlin. Preview as you write. Share as HTML or PDF.
import dev.limebeck.revealkt.dsl.*
import dev.limebeck.revealkt.dsl.slides.*
title = "Hello, Kotlin."
slides {
regularSlide {
+title { "Hello, Kotlin." }
+regularText { "From an idea to your first slide." }
}
}Familiar Kotlin, reusable functions, and version-controlled slides.
Save your script. The browser reloads your presentation.
Speaker notes, incremental fragments, and HTML or PDF export.
The packaged CLI needs no Node.js, Gradle, or Maven installation. Use JBang below, or download the standalone JAR.
Check java -version and install JBang. Run these commands and follow the PATH setup instructions.
jbang app setup
jbang app install --java 21 --name revealkt dev.limebeck:revealkt-cli:1.3.0Download the self-contained CLI JAR from release 1.3.0, rather than the sources, javadoc, or app-jvm artifacts. Rename it to revealkt.jar if needed. In the commands below, replace revealkt with java -jar /path/to/revealkt.jar.
The CLI creates a Demo directory with a script and assets. Open Demo/presentation/Demo.reveal.kts in your editor.
revealkt init DemoStart the server and open localhost:8080. Saving your script or assets updates the presentation.
revealkt run Demo/presentation/Demo.reveal.kts --host 127.0.0.1 --port 8080Chromium is only required for PDF. Install it with revealkt chrome install. Check your environment with revealkt doctor Demo/presentation/Demo.reveal.kts. Missing Chromium fails the check, but HTML preview and export still work.
Explore real presentations compiled from the bundled Kotlin scripts. Use the slide controls below, or open a presentation in its own tab.
Click inside the presentation to use arrow keys. Press Esc for the slide overview.
These demos track the current source. Use a CLI built from master to get the same slides; released versions may contain earlier examples. The first command creates the script and all assets.
revealkt init DslTour --example technical
revealkt run DslTour/presentation/DslTour.reveal.kts --host 127.0.0.1Replace Talk.reveal.kts below with the path to your script.
Check Java, paths, output access, and a real Chromium launch. The script is not executed.
revealkt doctor Talk.reveal.ktsRun a local preview. If an edit fails, the last working presentation stays available.
revealkt run Talk.reveal.kts --host 127.0.0.1Publish the entire out directory to a static host, including its JavaScript, CSS, and assets.
revealkt bundle Talk.reveal.kts --output-dir outInstall Chromium first. A separate port lets you keep the preview server running.
revealkt chrome install
revealkt pdf Talk.reveal.kts --port 8081 -o Talk.pdfChoose a built-in theme and numbering format. Combine all fragment steps on one slide page in PDF.
configuration {
theme = RevealKt.Configuration.Theme.Predefined.BLACK
slideNumber = RevealKt.Configuration.SlideNumber.Custom("c/t")
pdfSeparateFragments = false
}Add import dev.limebeck.revealkt.core.RevealKt. Use additionalCssStyle for small CSS overrides.
Place images and CSS in assets/. The image DSL adds this prefix for you.
// Inside regularSlide
+img(src = "logo.svg") { width = 320 }Set theme = RevealKt.Configuration.Theme.Custom("assets/theme.css") inside configuration. A custom theme replaces the built-in theme; style .reveal-viewport, .reveal, and headings. URLs inside CSS resolve relative to the CSS file. Start with a complete template: revealkt init ThemeStudio --example custom-theme.
unorderedListOf and orderedListOf reveal subsequent items as fragments by default. The first item is visible immediately. Pass fragmented = false for a static list. Set pdfSeparateFragments = false to avoid extra PDF pages for fragment steps.
Fix the script and save again. Successful compilation updates the slides and removes the error panel. Until then, you can navigate the last working presentation. An error on the initial launch exits the command; fix the script and start it again.
Run revealkt chrome install, then revealkt doctor Talk.reveal.kts. On Ubuntu, you may need system libraries: revealkt chrome install --with-deps. If the port is busy, stop the preview or use --port 8081. Create the PDF output's parent directory beforehand.
Check that assets/ is beside your script. For assets/images/chart.png, use img(src = "images/chart.png"). Paths are case-sensitive. CSS theme URLs need the full assets/ prefix.
Built-in JavaScript and CSS ship with the CLI. External images, fonts, and MathJax may still need a network connection, so offline export is not guaranteed. HTML export is a directory, not one file. Repeating bundle does not remove old assets; use a fresh output directory for a clean export.
A .reveal.kts file is executable Kotlin with your user's permissions, including file and network access. Review scripts before running them. Preview has no authentication and listens only on localhost unless you pass --host 0.0.0.0. Use bundle for publishing.