Skip to content
/ sorg Public

A Go-based static site generator that compiles brandur.org.

License

Notifications You must be signed in to change notification settings

brandur/sorg

Folders and files

NameName
Last commit message
Last commit date

Latest commit

58ca608 · Apr 6, 2025
Mar 25, 2025
Apr 6, 2025
Dec 26, 2023
May 27, 2024
May 28, 2024
Mar 25, 2025
Nov 14, 2020
Jan 3, 2025
Oct 8, 2018
Jul 22, 2024
Jan 3, 2025
Jan 12, 2021
Dec 26, 2023
Mar 25, 2025
Sep 25, 2017
May 27, 2024
May 22, 2019
Apr 21, 2021
Apr 4, 2025
Oct 1, 2024
Dec 28, 2022
May 24, 2024
Apr 4, 2025
Apr 4, 2025
Feb 10, 2024
Apr 19, 2023
Mar 13, 2025
May 22, 2024
Sep 30, 2024
May 9, 2019

Repository files navigation

sorg Build Status

A Go-based build script that compiles my personal website. This is the site's second incarnation, with the original being a Ruby/Sintra stack (sorg = "static org").

The site deploys automatically from its CI build with GitHub Actions as changes are committed to the master branch.

Clone

git clone https://github.com/brandur/sorg.git

Build

Install Go 1.9+ and direnv, then:

cp .envrc.sample .envrc

direnv allow

# Compile Go executables.
make install

# Run an initial build of the site, look for build output in public/.
make build

# Watch for changes in Go files and/or content and recompile and rebuild when
# one occurs.
make loop

The project can be deployed to s3 using:

pip install awscli

export AWS_ACCESS_KEY_ID=...
export AWS_SECRET_ACCESS_KEY=...
export S3_BUCKET=...
make deploy

Cached photos can be fetched using:

make photographs-download

Development

Run the entire lifecycle like in CI:

make

Run the test suite:

make test

Run a single package's test suite or single test:

go test ./markdown
go test ./markdown -run TestCollapseHTML

Get more verbose output while running tests:

go test -v ./markdown

About

A Go-based static site generator that compiles brandur.org.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published