typelevel / laika   0.19.5

Site and E-book Generator and Customizable Text Markup Transformer for sbt, Scala and Scala.js

Latest Release

• The latest pre-release is version 1.0.0-M5.
• The latest stable release is version 0.19.5.

If you are starting a new project with Laika, it is recommended to use the latest 1.0 milestone. It is the final milestone and already very close to the first release candidate and will prevent the need for a future migration. 0.19 won't receive any further patches unless a severe issue surfaces.

The library is published to Maven Central for Scala 3, 2.13, 2.12 and supports cats-effect 3.x and Scala.js 1.13+.
The sbt plugin is published for sbt 1.x.

Open Source under the Apache 2.0 License.

Adding Laika to your Build

The 1.0 milestones are published under org.typelevel organization, while the older 0.x releases were published under the org.planet42 organization:

// for version 1.x:
addSbtPlugin("org.typelevel" % "laika-sbt" % "1.0.0-M5")

// for version 0.19:
addSbtPlugin("org.planet42" % "laika-sbt" % "0.19.5")

Features

• No External Tools

  Easy setup without any external tools or languages and only minimal library dependencies.

• Flexible Runtime

  Laika can be used as an sbt plugin, as a Scala library for the JVM or in the browser via Scala.js.

• Purely Functional

  Fully referentially transparent, no exceptions or runtime reflection and integration with cats-effect for polymorphic effect handling.

• Rich Feature Set

  Markdown and reStructuredText as input, HTML, EPUB and PDF as output, integrated preview server and syntax highlighting, link validation, auto-generated navigation, versioned documentation, and much more.

• Lightweight Theme

  The default Helium theme includes only a minimal amount of handcrafted CSS and JS, no Bootstrap, no frameworks.

• Highly Extensible

  Process the document AST, adjust rendering for individual AST nodes or extend text markup languages with custom directives.

Further Information

• Read the Manual.

• Browse the API.

• Create Issues for bug reports or enhancement requests.

• Ask questions or share ideas in Discussions
  or in the #laika channel of the Typelevel Discord.