nikueater / siteelm

static site generator for Elm

demo: https://siteelm.netlify.com/ (source)

about

It's just another static site generator for Elm, but has some features.

• you can write YAML in preamble sections
• in a preamble, you can load external YAML files
• it's easy to mix dynamic Elm components
• simple rules to use

concept

to make a template, what you need to do is writing preamble models, their decoder, and two functions return Html Never (for HEAD and BODY)

usage

install

% npm install -g elm
% npm install -g siteelm

or if you'd like to do everything locally,

% npm install -D elm siteelm

in this case, type "% npx siteelm 〜" instead of "% siteelm 〜"

initialize project

% mkdir mysite
% cd mysite
% siteelm init

Then you'll see a scaffold in the directory.

developing

% cd mysite
% siteelm server -d

Then access "http://localhost:3000/"
The server supports file watching and auto reloading. If you don't need the server, use siteelm watch instead.

building

% cd mysite
% siteelm make -o

siteelm's Issues

supporting auto indexing

overview

supporting the auto indexing, which is useful for making blogs or news sites.

idea

Like the "external" property in preambles, we provides the "preamblesIn" property which generate a list of contents in a directory.

---
module: Layout.Index
contents: 
    preamblesIn: ./articles
---

template selector

overview

providing several templates for initializing

idea

Add more templates in "res/scaffold" so that a user can choose one of them with "siteelm init."

% siteelm init
> choose a template(default: 0)
> [0] blog
> [1] minimum
> [2] demo

efficient contents watching

overview

Right now, siteelm's file watcher re-compiles all the files in the content directory when one of them is modified.
I'd like to make it more efficient so that siteelm just compiles only files modified.

idea

When a file is modified, siteelm searches files which load it in their preambles and compiles only them.