Skip to content


Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time

Maven Central License Join the chat at GitHub Issues


sbt-microsites is an SBT plugin that facilitates the creation of fancy microsites for your projects, with minimal tweaks.

What is a microsite?

A microsite is an instance of Jekyll, ready to publish a static web page for your new library. Some of the benefits of having these auto-generated web pages are:

  • You can write documentation easily in markdown format.
  • Templates, layouts, styles, and other resources will be available through the plugin at compile time.
  • You don't have to deal with the styling.


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.

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

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


We recommend taking a look at the Getting Started section in the documentation since there are some prerequisites that are needed to build your microsite.


Microsites comes with a range of options to customize and configure your project's site. Please visit the documentation section for more information.

sbt-microsites in the wild

Many Scala projects, libraries, and applications use sbt-microsites to display documentation and project notes. If you wish to add your library here, please consider a PR to include it in the list below.

Cats Cats A library of typeclasses for functional programming, such as functors, monads, and arrows.
Scalaz Scalaz A library of typeclasses for functional programming, such as functors, monads, and arrows.
Cats-Effect Cats-Effect Extension of Cats for general effect types, with asynchronicity and concurrency
FS2 fs2 Functional Streams for Scala (FS2), based on cats and cats-effect
PureConfig pureconfig A library for loading configuration files
Ciris ciris A configuration as code library for compile-time safe configurations
Tuco Tuco Tuco is a reasonable telnet server for Scala
Atto Atto Everyday parsers.
Typelevel Scala Typelevel Scala Our fork of the Scala compiler
Monocle Monocle Optics library for Scala
ScalaCache ScalaCache A facade for popular cache implementations, such as Caffeine, Redis, or Memcached
scalacheck-toolbox scalacheck-toolbox Generating sensible data with ScalaCheck
Algebird Algebird Algebraic typeclasses and data structures for big data
Scalding Scalding Scala API for Hadoop and Cascading
Finch Finch A combinator API over the Finagle HTTP services
fetch fetch Simple & Efficient data access for Scala and Scala.js
github4s github4s A GitHub API wrapper written in Scala
hammock hammock A purely functional HTTP client for Scala
cron4s cron4s A CRON expression parser and AST for Scala
freestyle freestyle A cohesive & pragmatic framework of FP centric Scala libraries
libra libra A dimensional analysis library based on dependent types
Scanamo Scanamo Simpler DynamoDB access for Scala
Mocked Streams Mocked Streams Scala DSL for Unit-Testing Kafka Streams Topologies
sbt-kubeyml sbt-kubeyml Typesafe Kubernetes manifests to deploy Scala applications


sbt-microsites is designed and developed by 47 Degrees

Copyright (C) 2016-2020 47 Degrees.