Sbt Site

Overview

sbt-site is an sbt plugin that generates project websites from static content, GitBook, Paradox, and/or Asciidoctor. It can also optionally include generated Scaladoc. This plugin is designed to work in conjunction with publishing plugins like sbt-ghpages. In version 1.5.0, some integrations with other tools like Jekyll, Sphinx, Pamflet, Nanoc, Hugo, and Laika were removed.

Features

• Generates project websites from static content, GitBook, Paradox, and/or Asciidoctor
• Supports integration with publishing plugins like sbt-ghpages
• Can include generated Scaladoc
• Removed integrations with Jekyll, Sphinx, Pamflet, Nanoc, Hugo, and Laika in version 1.5.0

Installation

To install the sbt-site plugin, follow these steps:

1. Add the following line to your plugins.sbt file:

addSbtPlugin("com.typesafe.sbt" % "sbt-site" % "x.x.x")

Replace the x.x.x with the specific version of sbt-site you want to install.

2. In your project’s build.sbt file, add the following line:

enablePlugins(SitePlugin)

3. Run the following command in the sbt shell to generate the project website:

sbt makeSite

4. The generated website will be available in the target/site directory.

Summary

sbt-site is an sbt plugin that allows you to easily generate project websites from various content sources. It supports integration with publishing plugins and can include generated Scaladoc. In version 1.5.0, some integrations with other tools were removed. Overall, sbt-site is a useful tool for generating and managing project websites within the sbt ecosystem. Visit the documentation for more information about sbt-site and its usage.