weblorg-docker

A companion container image that helps to streamline the iteration loop when developing emacs-love/weblorg sites.

The image nanzhong/weblorg is regularly built and pushed to Docker Hub. In general, nanzhong/weblorg:latest should be stable and ready for use. However, tags that are pinned to releases are built using the same name as the release and can be also be used.

How it works

This container handles the rebuild iteration loop that’s typical of static site generator. It expects a weblorg site to be mounted in and it will watch for changes triggering rebuilds as necessary. It imposes very little assumptions to how the weblorg site is configured except that a self-contained emacs lisp file exists that defines the weblorg site. Pre and post build scripts are also supported if additional processing is needed.

The built static site is served using Caddy on port 80.

Included dependencies

• Emacs 27.1
• sass
• Caddy

Usage

Development

Example usage

docker run \
       -v $(pwd -P):/workspace \
       -p 8080:80 \
       --rm \
       --name weblorg \
       nanzhong/weblorg

This container image expects the weblorg site to be mounted as a volume into the container (by default to /workspace). A caddy file server serves the built static site on port 80. Any file changes will kick off a rebuild of the site.

One Time Build

docker run \
       -v $(pwd -P):/workspace \
       --rm \
       --name weblorg \
       nanzhong/weblorg build

This forgoes the file watching and serving of the static site and instead just performs a one time build of the site.

Configuration

There are a number environment variables that can be set to configure the behaviour. The defaults are shown below.