templum

A static site generator for templ.

Install

go install github.com/cugu/templum/cmd/templum@latest

Usage

Generate a site from the content folder to the public folder:

templum --content content --output public --user "https://cugu.github.io/templum/"

Content

Content is written in Markdown.

The content directory structure is:

content
├── config.yaml
├── index.md
├── 1 Something.md
├── 2 Something else.md
│   ├── 1 My Topic .md
│   └── 2 My Other Topic.md
├── 3 Another thing.md
└── logo.svg

config.yaml

The config file contains the site base url and the GitHub url:

github_url: "https://github.com/cugu/templum" # optional
logo: "templum.svg"
title: "templum"

d2_sketch: false  # default
d2_theme_name: "Vanilla nitro cola"  # see for more themes: https://pkg.go.dev/oss.terrastruct.com/d2/d2themes/d2themescatalog
d2_layout: degre  # default, optional: elk
# style: | # optional, to set custom css
#     .prose {
#         max-width: 120ch !important;
#     }

Folders and Markdown files

The folder structure is used to create the navigation. Number prefixes are used to order the pages and are removed from the navigation.