raboof / paradox-theme-reveal.js

Paradox theme and sbt plugin for creating reveal.js presentations with Paradox

Version Matrix

reveal.js theme for Paradox

This plugin extends the Paradox sbt plugin with useful directives and a theme to create Reveal.js presentations.

The main advantage is that this makes it easy to include code snippets from this sbt projects.

Usage

Add to project/plugins.sbt:

addSbtPlugin("net.bzzt" % "sbt-paradox-reveal-js" % "0.1.0-SNAPSHOT")

Add to your settings:

enablePlugins(ParadoxRevealPlugin)
paradoxTheme := Some("net.bzzt" % "paradox-theme-reveal-js" % "0.1.0-SNAPSHOT")

Write your presentation as a paradox page in src/main/paradox as described in the paradox documentation

sbt paradox will generate the presentation and place it in target/paradox/main/site

Alternatives

This theme has been inspired by the excellent tut. The main advantage of paradox is that it supports snippets from files in other languages than Scala, and makes it easy to maintain code snippets in an IDE. The advantage of tut is that it allows including not just the code, but also the output that code would give on the REPL.

TODO

  • generate page.st from upstream index.html
  • clean up and document directives
  • take reveal.js from a submodule rather than duplicating
  • properly generate the akka theme