scala-sbt.org Website Source

This is the codebase behind scala-sbt.org, the official documentation and landing page for sbt (a build tool for Scala). It's essentially the blueprint that developers working on sbt use to publish their documentation online. Anyone can contribute by submitting improvements or adding information — the README even encourages plugin authors to add their own projects to a community plugins list via pull requests.

The site is built using two different static site generators working together. Nanoc handles the prettier landing pages and introductory content, while Pamflet (a documentation engine built specifically for Scala projects) generates all the detailed technical docs. Think of it like having two different tools optimized for different jobs — one for marketing-friendly pages, one for dense reference material. An automation layer called sbt-site ties everything together, and pushes the finished site to GitHub Pages, which hosts it publicly.

To work on this locally, you need to install Ruby and a few supporting libraries since nanoc runs on Ruby. On the build side, you'll need Java 7 installed. Once set up, developers can run a simple command to build the entire site locally and see how it looks before publishing it live. The setup isn't trivial — there are platform-specific instructions for Mac and Ubuntu — but once everything is configured, updating the docs is straightforward.

This project matters to anyone building Scala tools or plugins who wants their work documented in the official sbt ecosystem. It's a collaborative resource, so contributors get recognized in the project's history. The README is practical and assumes you already know why you're here — it's less about explaining what sbt is and more about how to edit and deploy this specific website.