Prerequisites

To satisfy the jekyll prerequisite, here are a few hints for local and travis environments.

Local Environment

Depending on your platform, you might do this with:

yum install jekyll

apt-get install jekyll

gem install jekyll

Note: On MacOS X, /usr/bin/gem will install an incompatible version of jekyll. It is suggested that you use Homebrew to install ruby (which provides gem) before running gem install jekyll.

Continuous Integration - Travis

If you have enabled Travis for your project, you might have to tweak some parts of your .travis.yml file:

Potentially, your project is a Scala project (language: scala), therefore you need to add the bundle gems vendor path in the PATH environment variable:

before_install:
 - export PATH=${PATH}:./vendor/bundle

This is needed in order to install and be able to use the jekyll gem from other parts of your travis descriptor file. Once we have the /vendor/bundle path in the Travis PATH env variable, we have to install the gem in the install travis section:

install:
  - rvm use 2.2.8 --install --fuzzy
  - gem update --system
  - gem install sass
  - gem install jekyll -v 3.2.1

Set it up in your Project

To begin, add the following lines to the project/plugins.sbt file within your project or sbt module where you want to use the sbt-microsites plugin. Depending on the version, you might want to use:

Latest release:

addSbtPlugin("com.47deg"  % "sbt-microsites" % "0.7.18")

Finally, to enable the plugin, add this to your build.sbt file:

enablePlugins(MicrositesPlugin)