An sbt plugin to create awesome microsites for your project
@47erbot, @BenFradet, @juanpedromoreno, @scala-steward and @slice
@47erbot, @juanpedromoreno and @scala-steward
This release includes a completely redesigned style, which is offered through the use of a new feature: themes. The default theme is named light
, and features clean lines and a minimalistic design.
sbt-microsites
is still totally customizable, and users can implement their personal style. Previous style hasn't been discarded, so users have the option of creating a microsite with the previous style, which is named pattern
style.
These are the main aspects of the new light
style, for which we have disposed of Bootstrap to use our own CSS styling.
Default layout when setting the index.md
as layout: home
. It is similar to the previous home
layout, but the main difference you'll notice is that we removed the background pattern from the header. The rest of the elements in this layout remain the same, but in a more stylized and attractive way.
A completely new layout for v1.0.0, and its main characteristic is the features section that is placed after the header, and where the user can highlight three main aspects of a library.
The example below shows how to display this layout:
---
layout: homeFeatures
features:
- first: ["Configuration", "sbt-microsites facilitates the creation of fancy microsites for your projects, with minimal tweaks"]
- second: ["Customize", "sbt-microsites provides a considerable scope for improvement and customization in terms of images and styles"]
- third: ["Documentation", "Writing documentation for your own microsites is fast and easy, so you don't have to deal with details"]
---
The features are identified for the set of keys (first
, second
, third
), and you can add the title and a description for any feature in your library.
The default theme for the code highlighting has been changed to vs, although this is configurable as described in the sbt-microsites customize section.
sbt-microsites
now offers initial support to build different versions of your library documentation.
To start using this new feature, get a look at the new task makeMultiversionMicrosite
. This will go through the new micrositeVersionList
setting, where you can set a list of versions you want to build:
micrositeVersionList := List("0.1.0", "0.2.0")
And then the main microsite will now show you a selector of links to those versions microsites.
mdoc is now the default markdown code typechecking tool, currently updated to v2.0.2. Because of this, sbt-microsites users who are still using tut
in their microsites must follow the steps described here to use mdoc
, or adapt your build accordingly in order to keep using tut
.
light
theme, now using vanilla JavaScript.Additionally, you can read more information on the sbt-microsites website
sbt
version in Travis, change micrositeDocumentationUrl
#383scalatest
to 3.1.0 #381scalactic
to 3.1.0 #380sbt
to 1.3.4 #378micrositeExtraMdFilesOutput
default folder #377sbt-mdoc
to 2.0.2 #371sbt-microsites
documentation folder #365java.awt.headless=true
#363mdoc
by default #362mdoc
sources setting, not ThisBuild #357 by @pdalpra