Home

Awesome

Maven Central License Join the chat at https://gitter.im/47degrees/sbt-microsites GitHub Issues

sbt-microsites

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:

Installation

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.4")

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

enablePlugins(MicrositesPlugin)

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.

Documentation

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.

CatsCatsA library of typeclasses for functional programming, such as functors, monads, and arrows.
ScalazScalazA library of typeclasses for functional programming, such as functors, monads, and arrows.
Cats-EffectCats-EffectExtension of Cats for general effect types, with asynchronicity and concurrency
FS2fs2Functional Streams for Scala (FS2), based on cats and cats-effect
PureConfigpureconfigA library for loading configuration files
CiriscirisA configuration as code library for compile-time safe configurations
TucoTucoTuco is a reasonable telnet server for Scala
AttoAttoEveryday parsers.
Typelevel ScalaTypelevel ScalaOur fork of the Scala compiler
MonocleMonocleOptics library for Scala
ScalaCacheScalaCacheA facade for popular cache implementations, such as Caffeine, Redis, or Memcached
scalacheck-toolboxscalacheck-toolboxGenerating sensible data with ScalaCheck
AlgebirdAlgebirdAlgebraic typeclasses and data structures for big data
ScaldingScaldingScala API for Hadoop and Cascading
FinchFinchA combinator API over the Finagle HTTP services
fetchfetchSimple & Efficient data access for Scala and Scala.js
github4sgithub4sA GitHub API wrapper written in Scala
hammockhammockA purely functional HTTP client for Scala
cron4scron4sA CRON expression parser and AST for Scala
freestylefreestyleA cohesive & pragmatic framework of FP centric Scala libraries
libralibraA dimensional analysis library based on dependent types
ScanamoScanamoSimpler DynamoDB access for Scala
Mocked StreamsMocked StreamsScala DSL for Unit-Testing Kafka Streams Topologies
sbt-kubeymlsbt-kubeymlTypesafe Kubernetes manifests to deploy Scala applications

Copyright

sbt-microsites is designed and developed by 47 Degrees

Copyright (C) 2016-2020 47 Degrees. http://47deg.com