Collection of best practices for the Scala programming language
Clone or download
Latest commit f53be1c Jan 10, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
project [4] Switch from tut to mdoc Jan 6, 2019
src remove extra 'is' Jan 9, 2019
.gitignore Add basic structure Dec 30, 2018
.travis.yml Add basic structure Dec 30, 2018
LICENSE Add basic structure Dec 30, 2018
README.md [4] Switch from tut to mdoc Jan 6, 2019
build.sbt [4] Switch from tut to mdoc Jan 6, 2019

README.md

Building the site

Required tools

The following tools are needed to build the site:

  • sbt, to compile and assemble all examples
  • jekyll, to turn the output into a static site

Steps

You first need to run all pages through the amazing mdoc to make sure all examples are valid:

sbt makeSite

This will generate jekyll sources in ./target/site. For local development / browsing, the simplest thing to do is to run the following from ./target/site:

jekyll serve --watch -c _config.yml --baseurl ""

This will make the entire site available on http://localhost:4000.