SLAM/MATU Website

Hippocratic License HL3-FULL

A website for Syndicat des Locataires Autonomes de Montréal (SLAM)

Built with Zola.

Contributing

This project uses Just as a task runner, Podman to containerize tasks. In this way, only those two executables are required to dev on this system. Zola runs in the Podman container.

Running the dev server

The development server offers live reloading. It exposes the web server on port 8080 by default, and a websocket on port 1024 for live reload.

To run the dev server, run:

just

You can specify a port for the webserver to be exposed over like so:

# This will serve the dev server on port 8888
just serve 8888

Seeding some phony content

It can be handy to generate a lot of content, so there's a recipe for that:

# Generate 32 pages in the "news" section. They'll be prefixed by the word
# 'phony-' and will have the 'test' tag.
just gen-phony

Directories beginning with phony- are ignored by git, so don't worry about pushing them to the repo.

You can customize the generated phony pages too:

# Generate 100 phony pages
just gen-phony 100
# Generate the pages in a different section
just gen-phony section="elsewhere"
# Generate 100 phony pages in the phony section
just gen-phony 100 section="phony"

Once you're done, the del-phony recipe can remove them:

just del-phony

Building the project

To build the project, run:

just build

You can override the base URL by passing it to the build recipe:

just build example.com

That's pretty much it.