README.md
May 14, 2026 ยท View on GitHub
โ๏ธ Scala Website Config
Common configuration for all of my Scala websites.
๐ท What's the workflow?
Changes made to the configuration files contained herein are automatically copied into each dependent project using Github Graph. Updates to these files should be made here, not in any of the downstream repositories, lest they be overwritten later.
๐ What's included?
- Everything from Scala Config.
- SBT plugins for Scala.js.
๐๏ธ Where is this used?
The full list of projects that rely on this configuration is defined in graph.json.
๐ค Should I use this in my projects too?
Only if you want to, but this exists mainly for my own convenience. I would, however, argue that these settings are reasonable defaults for many new Scala websites.
More likely, if you're starting a new project, you'll want to use the downstream template Scala Website Template.
๐จ How can this be used?
You have several options:
- If you want continuous updates as this repository evolves, open a PR to add your project(s) to graph.json. You'll also need to send me a PAT with write access to the corresponding repositories.
- If you want continuous updates, but want to deviate from my template according to your own needs, fork this repository and then add your project(s) to graph.json (after removing the existing projects from the list). In this case, you can add the PAT yourself.
- If you just want the settings without the updates, click 'Use this template' on GitHub (for a new project), or simply copy and paste the files (for an existing project).
๐ฎโโ๏ธ License
The included MIT license should be considered only as part of the template, and is not binding. This repository is hereby released to the public domain, to be used freely. In particular, and contra LICENSE.md, you may remove the license text from copies.
๐๏ธ See also
- Scala Website Template is a full template which uses this configuration.
- Scala Config is an upstream template for Scala 3 projects in general.