https://github.com/cugu/templum
🏛️ A static site generator.
https://github.com/cugu/templum
go server-side-rendering static-site-generator
Last synced: 5 months ago
JSON representation
🏛️ A static site generator.
- Host: GitHub
- URL: https://github.com/cugu/templum
- Owner: cugu
- License: gpl-3.0
- Created: 2023-10-28T14:27:50.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-09-04T04:52:15.000Z (7 months ago)
- Last Synced: 2025-09-04T06:30:32.992Z (7 months ago)
- Topics: go, server-side-rendering, static-site-generator
- Language: CSS
- Homepage: https://cugu.github.io/templum/
- Size: 25.3 MB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# templum
A static site generator for [templ](https://github.com/a-h/templ).
## Install
```bash
go install github.com/cugu/templum/cmd/templum@latest
```
## Usage
Generate a site from the `content` folder to the `public` folder:
```bash
templum --content content --output public --user "https://cugu.github.io/templum/"
```
## Content
Content is written in [Markdown](https://www.markdownguide.org/cheat-sheet/).
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:
```yaml
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.