Customizable and extensible toolkit for transforming lightweight text markup and template based site generation.
Supporting Markdown and reStructuredText as input and HTML, EPUB and PDF as output, either through its integrated sbt plugin or embedded in Scala applications, without the need to install external tools.
Open Source under the Apache 2.0 License.
The main artifact is published to Maven Central for Scala 2.13 and 2.12.
The sbt plugin is published to the sbt plugin repository for sbt 1.x.
The final release for Scala 2.11 had been 0.10.0, the final release for Scala 2.10 and sbt 0.13 was 0.7.0.
Using the sbt Plugin
Add the plugin to
addSbtPlugin("org.planet42" % "laika-sbt" % "0.11.0")
Enable the plugin in your project's
Add Markdown, reStructuredText or HTML template files to
src/docs in your
project and run the
laikaSite task from within sbt to generate the site
Using the Library API
Adding the Laika dependency to your sbt build:
libraryDependencies += "org.planet42" %% "laika-core" % "0.11.0"
Example for transforming from file to file:
Transform .from(Markdown) .to(HTML) .fromFile("hello.md") .toFile("hello.html")
Example for transforming an entire directory of markup files:
Transform .from(ReStructuredText) .to(HTML) .fromDirectory("source") .toDirectory("target")
Example for transforming an entire directory of markup files to a single PDF file:
Transform .from(Markdown) .to(PDF) .fromDirectory("source") .toFile("hello.pdf")
When using Laika's PDF support you need to add one more dependency to your build:
libraryDependencies += "org.planet42" %% "laika-pdf" % "0.11.0"
For further information:
*Note that all licence references and agreements mentioned in the Laika README section above are relevant to that project's source code only.