Paradox

The sbt-site plugin has direct support for building Paradox projects.

To enable the “sbt site Paradox” plugin in your sbt project, add the following to your project/plugins.sbt file:

addSbtPlugin("com.github.sbt" % "sbt-site-paradox" % "1.5.0")

And enable the ParadoxSitePlugin plugin in your build.sbt file:

sourceenablePlugins(SitePreviewPlugin, ParadoxSitePlugin)

This assumes you have a Paradox project under the src/main/paradox directory. To change this, set the sourceDirectory key in the paradox task scope:

paradox / sourceDirectory := sourceDirectory.value / "doc"

If you are configuring Paradox from scratch remember to also configure a theme:

sourceparadoxTheme := Some(builtinParadoxTheme("generic"))

Note that all of the Paradox settings mentioned in the Paradox documentation are reused by sbt-site. For example to configure an @extref link prefix use:

sourceparadoxProperties ++= Map(
  "extref.rfc.base_url" -> "https://tools.ietf.org/html/rfc%s"
)

Edit this page

1.5.0