https://github.com/47degrees/sbt-microsites
An sbt plugin to create awesome microsites for your project
https://github.com/47degrees/sbt-microsites
jekyll microsite sbt scala
Last synced: 28 days ago
JSON representation
An sbt plugin to create awesome microsites for your project
- Host: GitHub
- URL: https://github.com/47degrees/sbt-microsites
- Owner: 47degrees
- License: apache-2.0
- Created: 2016-09-05T23:33:02.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-04-29T05:19:31.000Z (about 1 year ago)
- Last Synced: 2024-05-20T22:27:55.186Z (12 months ago)
- Topics: jekyll, microsite, sbt, scala
- Language: SCSS
- Homepage: https://47degrees.github.io/sbt-microsites/
- Size: 5.48 MB
- Stars: 317
- Watchers: 51
- Forks: 64
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Authors: AUTHORS.md
Awesome Lists containing this project
README
[](https://repo1.maven.org/maven2/com/47deg/sbt-microsites_2.12_1.0) [](https://raw.githubusercontent.com/47degrees/sbt-microsites/master/LICENSE) [](https://gitter.im/47degrees/sbt-microsites?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [](https://github.com/47degrees/sbt-microsites/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:
- You can write documentation easily in markdown format.
- Templates, layouts, styles, and other resources will be available through the plugin at compile time.
- You don't have to deal with the styling.
# 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](https://47degrees.github.io/sbt-microsites/docs/) 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](https://47degrees.github.io/sbt-microsites/docs/) 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.
★ | ★ | ★
--- | --- | ---
 | [**Cats**](http://typelevel.org/cats/) | A library of typeclasses for functional programming, such as functors, monads, and arrows.
 | [**Scalaz**](https://scalaz.github.io/7/) | A library of typeclasses for functional programming, such as functors, monads, and arrows.
 | [**Cats-Effect**](https://github.com/typelevel/cats-effect) | Extension of Cats for general effect types, with asynchronicity and concurrency
 | [**fs2**](http://fs2.io/guide.html) | Functional Streams for Scala (FS2), based on `cats` and `cats-effect`
 | [**pureconfig**](https://pureconfig.github.io/) | A library for loading configuration files
 | [**ciris**](https://cir.is/) | A _configuration as code_ library for compile-time safe configurations
 | [**Tuco**](https://tpolecat.github.io/tuco/) | Tuco is a reasonable telnet server for Scala
 | [**Atto**](https://tpolecat.github.io/atto/) | Everyday parsers.
 | [**Typelevel Scala**](http://typelevel.org/scala/) | Our fork of the Scala compiler
 | [**Monocle**](http://julien-truffaut.github.io/Monocle/) | Optics library for Scala
 | [**ScalaCache**](https://cb372.github.io/scalacache/) | A facade for popular cache implementations, such as Caffeine, Redis, or Memcached
 | [**scalacheck-toolbox**](https://47deg.github.io/scalacheck-toolbox/) | Generating sensible data with ScalaCheck
 | [**Algebird**](https://twitter.github.io/algebird/) | Algebraic typeclasses and data structures for big data
 | [**Scalding**](https://twitter.github.io/scalding/) | Scala API for Hadoop and Cascading
 | [**Finch**](https://finagle.github.io/finch/) | A combinator API over the Finagle HTTP services
 | [**fetch**](https://47deg.github.io/fetch/) | Simple & Efficient data access for Scala and Scala.js
 | [**github4s**](https://47deg.github.io/github4s/) | A GitHub API wrapper written in Scala
 | [**hammock**](https://pepegar.github.io/hammock/) | A purely functional HTTP client for Scala
 | [**cron4s**](https://alonsodomin.github.io/cron4s) | A CRON expression parser and AST for Scala
 | [**freestyle**](http://frees.io/) | A cohesive & pragmatic framework of FP centric Scala libraries
 | [**libra**](https://to-ithaca.github.io/libra) |A dimensional analysis library based on dependent types
 | [**Scanamo**](http://www.scanamo.org) | Simpler DynamoDB access for Scala
 | [**Mocked Streams**](https://mockedstreams.madewithtea.com) | Scala DSL for Unit-Testing Kafka Streams Topologies
 | [**sbt-kubeyml**](http://sbt-kubeyml.vaslabs.org) | Typesafe Kubernetes manifests to deploy Scala applications
# Copyright
sbt-microsites is designed and developed by 47 Degrees
Copyright (C) 2016-2020 47 Degrees.