~dvko/gozer

Fast, opinionated and simple static site generator in a single static binary.
in atom feed, atom:generator value should be gozer, not gosite
Merge branch 'main' of github.com:dannyvankooten/gozer
use 0755 permissions on created directories

clone

read-only
https://git.sr.ht/~dvko/gozer
read/write
git@git.sr.ht:~dvko/gozer

You can also use your local clone with git send-email.

#Gozer!

Gozer is a fast & simple static site generator written in Golang.

  • Converts Markdown to HTML.
  • Allows you to use page-specific templates.
  • Creates an XML sitemap for search engines.
  • Creates an RSS feed for feed readers.

Sample websites using Gozer:

#Installation

You can install Gozer using one of the following methods:

  • Download a precompiled binary from the latest release
  • If you have the Go compiler installed: go install github.com/dannyvankooten/gozer@latest

#Usage

Run gozer new to quickly generate an empty directory structure.

├── config.toml                # Configuration file
├── content                    # Posts and pages
│   └── index.md
├── public                     # Static files
└── templates                  # Template files
    └── default.html

Then, run gozer build to generate your site.

Any Markdown files placed in your content/ directory will result in an HTML page in your build directory after running gozer build.

For example:

  • content/index.md creates a file build/index.html so it is accessible over HTTP at /
  • content/about.md creates a file build/about/index.html so it is accessible over HTTP at /about/.

#Commands

Run gozer without any arguments to view the help text.

Gozer - a fast & simple static site generator

Usage: gozer [OPTIONS] <COMMAND>

Commands:
    build   Deletes the output directory if there is one and builds the site
    serve   Builds the site and starts an HTTP server on http://localhost:8080
    new     Creates a new site structure in the given directory

Options:
    -r, --root <ROOT> Directory to use as root of project (default: .)
    -c, --config <CONFIG> Path to configuration file (default: config.toml)

#Content files

Each file in your content/ directory should end in .md and have TOML front matter specifying the page title:

+++
title = "My page title"
+++

Page content here.

#Templates

The default template for every page is default.html. You can override it by setting the template variable in your front matter.

+++
title = "My page title"
template = "special-page.html"
+++

Page content here.

Templates are powered by Go's standard html/template package, so you can use all the actions described here.

Every template receives the following set of variables:

Pages       # Slice of all pages in the site
Posts       # Slice of all posts in the site (any page with a date in the filename)
Site        # Global site properties: Url, Title
Page        # The current page: Title, Permalink, UrlPath, DatePublished, DateModified
Title       # The current page title, shorthand for Page.Title
Content     # The current page's HTML content.

For example, to show a list of the 5 most recent posts:

{{ range (slice .Posts 0 5) }}
    <a href="{{ .Permalink }}">{{ .Title }}</a> <small>{{ .DatePublished.Format "Jan 02, 2006" }}</small><br />
{{ end }}

#License

Gozer is open-sourced under the MIT license.