« Changelog History


sbt-microsites v1.0.0 Release Notes

Release Date: 2019-02-12 // about 5 years ago

  • 🔖 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.
    • 0️⃣ 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, change micrositeDocumentationUrl #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
    • 0️⃣ mdoc by default #362
    • 👉 Use project scope for mdoc sources setting, not ThisBuild #357 by @pdalpra
    • 🆕 New style redesign #354