Getting Started

Deploy

Ship your site — to GitHub Pages, Netlify, Cloudflare Pages, or any static host.

The theme produces a fully static site. Anywhere that serves files works.

GitHub Pages (recommended for the demo) #

The theme repo ships with a workflow at .github/workflows/pages.yml that builds exampleSite/ and publishes to the gh-pages branch on every push to main.

To use it for your own site:

Enable Pages

1 min

In your repo settings, Pages → Source → GitHub Actions.

Adapt the workflow

2 min

Copy .github/workflows/pages.yml from this theme into your own site, and adjust the --source flag if your Hugo project lives at the repo root (drop the --source exampleSite argument).

Push

30 sec

git push origin main

In a minute the site will be live at https://<your-org>.github.io/<repo>/.

Netlify #

toml
# netlify.toml
[build]
  publish = "public"
  command = "hugo --minify"

[build.environment]
  HUGO_VERSION = "0.125.0"

Connect the repo on netlify.com — done.

Cloudflare Pages #

In the Cloudflare dashboard:

Build command: hugo --minify
Output dir: public
Environment variable: HUGO_VERSION = 0.125.0

Plain static hosting (S3, nginx, etc.) #

hugo --minify
rsync -avz --delete public/ user@server:/var/www/site/

That’s it — public/ is the entire deployable bundle.

Set baseURL correctly

The baseURL in your hugo.toml must match the deployed URL. For GitHub Pages this is usually https://<org>.github.io/<repo>/ — the trailing slash matters. Wrong baseURL produces broken asset paths and search index.