Static website generation in Groovy

#grain ul { list-style: square; list-style-position:inside; text-indent: 20px;}
#grain code { font-family: Lucidatypewriter, monospace}

A static site generator is software that translates content from a text format into HTML and creates consistant look and feel across all the pages. These HTML pages can be copied to any basic webserver. Usually the base format is Markdown or AsciiDoc which is then converted into an HTML snippet, and then put into a larger HTML page. After generation, those files are copied to a basic webserver that serves the plain HTML.

Static site generators are popular with the technical crowd. It takes the complexity off of the server (no database! no caching!) and puts it on our local machine. Most have some sort of command-line system that runs rsync to copy the updated files to the web server. Having just plain HTML makes the site more secure than traditional blogging platforms. It’s hard to do a Bobby Tables if there is no database, and you don’t have to worry about the latest PHP security updates — it’s all just plain o’ HTML, CSS, and JavaScript.

Going With The Grain

There are lots of different static site generators, usually multiple ones for each programming language. Groovy’s relatively new entry in to this world is Grain. The developers of Grain decided not to reinvent the wheel, but instead implement other technolgies in their software. For example, Grain will automatically generate CSS from SASS or SCSS sources. But instead of implementing their own SASS parser in Groovy, it attempts to use Ruby on your system and, failing that, it installs JRuby into it’s sandbox and runs the SASS gem from there. This is automatic — no user configuration is necessary for this to occur. Of course you can set a default if you want.

Other great things about Grain:

Best yet — it’s distributed under the Apache license.

To get started with Grain, you can grab one of the pre-built themes as a starting point. Then you can read the docs yourself. But after the initial setup, my workflow for a blog post is usually:

  • grain create-post <post name> — creates a Markdown file under content/blog
  • grain preview — starts the preview server
  • edit the the file and write away!
  • grain generate — generates the HTML files
  • grain deploy — run rsync on my generate files to the server

About the Author

Mike Hostetler profile.

Mike Hostetler

Principal Technologist

Mike has almost 20 years of experience in technology. He started in networking and Unix administration, and grew into technical support and QA testing. But he has always done some development on the side and decided a few years ago to pursue it full-time. His history of working with users gives Mike a unique perspective on writing software.

One thought on “Static website generation in Groovy

  1. Anders D. Johnson says:

    Mike, thanks for this nice article introducing us to SSGs and especially Grain. FYI, I noticed a typo in the page – it says “genration” rather than “generation” – as of 2015/11/19 11:45pm.

Leave a Reply

Your email address will not be published. Required fields are marked *

Related Blog Posts
Why we started using JSON Schema in our internal Helm charts
Helm 3 supports validating the provided chart values against a JSON Schema. While it may be quicker to get started in your chart development without a schema, we found it valuable for a number of […]
Rewriting files in Google Cloud Storage
Rewriting Files in GCP Note: even though this code is in Python, this should be the same idea in JavaScript, Go, etc. I wrote the following to copy a file from one Google Cloud Storage […]
Interpreting Spatial Data in the Age of COVID-19
As 2020 has come to an end, many are eager to leave the mess of COVID-19 behind with the new year and gain a fresh start. Unfortunately, new cases are still soaring across the United […]
Building a Better Mousetrap
Recently, my daughter (age 6) was into building “mousetraps” out of shoe boxes. These were more or less comfortable cardboard mouse houses complete with beds, rooms, everything a mouse could want or need and not […]