motform / statisk

library for data-driven static site generators

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Statisk

A library for data-driven static site generators.

Introduction

Statisk is a very small static site generator that I wrote to make non-blog-like sites portfolios. While primarily a fun/learning project, experience has shown me that the .md way of SSG proves a very crude fit to the type of pages that portfolios are comprised of. Instead, I'm trying out something open and data-driven (in the sense the Clojure community use the word) that might alleviate some of my precised frictions.

Statisk is completely dependency free, with an architecture that is heavily inspired by Reitit (albeit not as performance focus (yet)). It is important to note that every rebuild is done in full, no caching or other incremental shenanigans. This is by design – spitting out some web pages is insanely trivial. Any type of build complexion is bound to fail and get tripped up somewhere (esp. in my experience of other SSGs).

Unlike many other static site generators, Statisk is not a framework or a program, but a library, each part offered a la carte. It is structured through the pull -> transform -> push methodology as conceptualized by Zach Tellman in Elements of Clojure.

Please not that Statisk is still in an early, semi-active development. That said, I would never release any backwards incompatible changes.

Installation

Add the latest SHA to your deps.edn:

org.motform/statisk {:git/url "https://github.com/motform/statisk"
                     :sha <latest-sha>}

Usage

motform.statisk.core provides the primary API for re-building pages in a REPL environment. You could of course call it on the command line via clj -X, but that is not optimal unless you are doing a single build.

(There will be more instructions here later, including an example.)

Licence

Copyright © 2021 Love Lagerkvist

Distributed under the Eclipse Public License, the same as Clojure.

About

library for data-driven static site generators

License:Eclipse Public License 1.0


Languages

Language:Clojure 100.0%