main

Home of the SSG powering the dani museum

cmd
ssg
13 L
6 L
31 L
13 L
14 L

readme

glerc

glerc's logo

A small, werc-inspired and easy to use SSG, written in Go - Write pages in markdown, get them back as HTML files with a nice lil sidebar :D

installing

To install glerc, you need go >= 1.26.2.

Running go install codeberg.org/dani-institute/glerc/cmd/glerc@latest will install glerc to $HOME/go/bin.

usage

We recommend you look at The Dani Museum and dani's website to get an idea of what a page in glerc should look like.

The rundown is this:

  • HTML templates go in templates/ and must end with .html.
  • Assets (CSS, JS, images) go in assets/, we recommend organising them.
  • Pages go in pages/ and must end with .md.

(Documentation on what options the HTML template accepts will be documented when possible.)

configuration

Use config.toml to set your site's title, description and base URL. You can also set the sidebar order by doing the following :3

sidebar_order = ["index", "page1", "page2"]