Sbt Microsites

screenshot of Sbt Microsites
jekyll

Sbt Microsites

An sbt plugin to create awesome microsites for your project

Overview

sbt-microsites is an SBT plugin that allows developers to create microsites for their projects easily. These microsites are instances of Jekyll that can publish static web pages for new libraries. They offer benefits such as easy documentation writing in markdown format, availability of templates and styles through the plugin at compile time, and removal of the need to deal with styling.

Features

  • Easy documentation writing in markdown format
  • Availability of templates, layouts, styles, and other resources through the plugin at compile time
  • Eliminates the need to deal with styling

Installation

To install sbt-microsites, add the following lines to the project/plugins.sbt file within your project or sbt module:

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

To enable the plugin, add the following line to your build.sbt file:

enablePlugins(MicrositesPlugin)

For more information, refer to the Getting Started section in the documentation.

Summary

sbt-microsites is a useful SBT plugin that simplifies the creation of microsites for projects. It provides easy documentation writing, availability of templates and styles, and eliminates the need to deal with styling. The installation process is straightforward, and the plugin offers a lot of customization options for project sites. Many Scala projects and libraries are already using sbt-microsites for displaying documentation and project notes.

jekyll
Jekyll

Jekyll is a static site generator written in Ruby that allows you to create simple, fast, and secure websites without the need for a database.