anna

Anna

    ___
   /   |  ____  ____  ____ _
  / /| | / __ \/ __ \/ __ `/
 / ___ |/ / / / / / / /_/ /
/_/  |_/_/ /_/_/ /_/\__,_/

A static site generator in go

Inspired by Hugo and Saaru, this static site generator aims to take performance to the next level with parallel rendering, live reload and so much more, all in Go.

Pronounced: /ɐnːɐ/ which means rice 🍚 in Kannada

Get Started

To setup your site, follow the quick-start guide

Contributing to Anna

If you have git installed, clone our repository and build against the latest commit

git clone github.com/anna-ssg/anna
cd anna
make build

make build automatically wires up a pre-commit hook (tracked in .github/githooks/) that runs, in order: gofmt check, lint (go vet + golangci-lint if installed), audit (govulncheck if installed), the test suite, golangci-lint and govulncheck are optional; the hook skips those steps with a hint if they aren't installed.

You can also install the hook explicitly, without doing a full build, by running:

make install-hooks

If you ever need to skip it (e.g. a WIP commit), use git commit --no-verify.

Developer Guide

Detailed documentation for developers can be found here

History

This project was a part of the ACM PESU-ECC's yearly AIEP program, and is maintained by Adhesh Athrey, Nathan Paul, Anirudh Sudhir, and Aditya Hegde