Releases: 47degrees/sbt-microsites
v1.2.1
What's changed
- Update scalafmt-core to 2.5.1 (#481) @BenFradet
π Documentation
- Removes duplicated LICENSE file (#485) @juanpedromoreno
π Bug Fixes
π Dependency updates
- Update sbt-mdoc to 2.2.0 (#483) @scala-steward
- Update sbt-ci-release to 1.5.3 (#479) @scala-steward
Contributors to this release
@47erbot, @BenFradet, @juanpedromoreno, @scala-steward and @slice
v1.2.0
What's changed
- Upgrade Build (#475) @juanpedromoreno
- Update sbt to 1.3.9 (#458) @scala-steward
- Update sbt-microsites to 1.1.5 (#455) @scala-steward
- Releases 1.1.5 (#454) @juanpedromoreno
- Update sbt-mdoc to 2.1.5 (#453) @scala-steward
- Update sbt-microsites to 1.1.4 (#452) @scala-steward
β οΈ Breaking changes
- Removes Sbt-org-policies Dependency (#465) @juanpedromoreno
Contributors to this release
v1.1.4
v1.1.3
- Update sbt-microsites to 1.1.2 (#436)
- Update scalafmt-core to 2.4.2 (#437)
- Update sbt-org-policies to 0.13.1 (#438)
- Update org-policies-core to 0.13.1 (#439)
- Populate github owner/repo keys with default values from git remote (#440)
- Set absolute position to main features img relative to parent container (#441)
- Migrates from 47deg to 47degrees GH organization (#442)
- Release 1.1.3 (#443)
v1.1.2
- Remove default GitHub repo values (#426)
- Setting version to 1.1.2-SNAPSHOT (#429)
- Remove hardcoded sbt version from Travis config (#428)
- Declare proper doctype on layouts (#430)
- Update scalactic to 3.1.1 (#433)
- Update scalatest to 3.1.1 (#434)
- Upgrade sbt-org-policies and modify sign key importing (#431)
- Trigger new patch version (1.1.2) (#435)
v1.1.1
- Update sbt-microsites to 1.1.0 (#413)
- Update sbt to 1.3.7 (#414)
- Update org-policies-core to 0.12.3 (#415)
- Update sbt-org-policies to 0.12.3 (#416)
- Update sbt to 1.3.8 (#419)
- Implement feature links (#417)
- Update scalatags to 0.8.5 (#420)
- Update scalafmt-core to 2.4.0 (#422)
- Update scalafmt-core to 2.4.1 (#423)
- Update scalatags to 0.8.6 (#424)
- Release 1.1.1 (#425)
v1.1.0
- Update sbt-microsites to 1.0.2 (#395)
- Tell hljs the language of code blocks so it doesn't have to guess (#394)
- Update sbt to 1.3.5 (#396)
- Update scalacheck to 1.14.3 (#397)
- Simplify deployment - Improve docs (#399)
- Update scalatags to 0.8.1 (#400)
- Update scalatags to 0.8.2 (#401)
- Please add sbt-kubeyml (#402)
- Airframe has graduated from sbt-microsite (#403)
- Update sbt to 1.3.6 (#405)
- Update scalatags to 0.8.3 (#404)
- Update sbt-mdoc to 2.1.0 (#407)
- Add a troubleshooting page (#408)
- Update sbt-mdoc to 2.1.1 (#409)
- Update scalatags to 0.8.4 (#410)
- Update transitive offered mdoc to same in deps (#411)
- Trigger new minor version (1.1.0) (#412)
v1.0.2
v1.0.1
v1.0.0
Version 1.0.0 π
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.
Layouts π
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.
Home layout
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.
Features layout
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.
Docs layout
The default theme for the code highlighting has been changed to vs, although this is configurable as described in the sbt-microsites customize section.
Multiversion Support π’
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.
Breaking changes π¨
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
.
Other Features β¨
- Custom Sass/SCSS support when overwriting styles.
- Complete jQuery removal for new default
light
theme, now using vanilla JavaScript. - Use ES2015 syntax and newer browser APIs.
- Sidebar show/hide and current element activation behavior improvements.
- Update highlightjs to version 9.16.2.
- Complete streamline of web 3rd party dependencies.
- Various improvements on the site construction, getting rid of unused files and boilerplate content.
- Add more semantic tags, and include a11y attributes.
Additionally, you can read more information on the sbt-microsites website
Notable PRs π©βπ»
- Update
sbt
version in Travis, changemicrositeDocumentationUrl
#383 - Update
scalatest
to 3.1.0 #381 - Update
scalactic
to 3.1.0 #380 - Multiversion support #379
- Update
sbt
to 1.3.4 #378 - Changes
micrositeExtraMdFilesOutput
default folder #377 - Custom Sass/SCSS support #373
- Update
sbt-mdoc
to 2.0.2 #371 - Set homepage setting to be GitHub repo URL explicitely for the project #370
- Site home change #368
- Streamline web 3rd party dependencies #367
- Modify
sbt-microsites
documentation folder #365 - Features layout section implementation #364
- Adds Java property
java.awt.headless=true
#363 mdoc
by default #362- Use project scope for
mdoc
sources setting, not ThisBuild #357 by @pdalpra - New style redesign #354