CheatPress

Hugo Static site generator

Version 0.167.0 · source

Hugo, Postcard, light preview Light · Postcard 102 × 152 mm · PDF Hugo, Postcard, dark preview Dark · Postcard 102 × 152 mm · PDF Hugo, Postcard, ink saver preview Ink saver · Postcard 102 × 152 mm · PDF
Hugo, A5, light preview Light · A5 148 × 210 mm · PDF Hugo, A5, dark preview Dark · A5 148 × 210 mm · PDF Hugo, A5, ink saver preview Ink saver · A5 148 × 210 mm · PDF
Hugo, A4, light preview Light · A4 210 × 297 mm · PDF Hugo, A4, dark preview Dark · A4 210 × 297 mm · PDF Hugo, A4, ink saver preview Ink saver · A4 210 × 297 mm · PDF
Hugo, A4 landscape, light preview Light · A4 landscape 297 × 210 mm · PDF Hugo, A4 landscape, dark preview Dark · A4 landscape 297 × 210 mm · PDF Hugo, A4 landscape, ink saver preview Ink saver · A4 landscape 297 × 210 mm · PDF
Hugo, A3, light preview Light · A3 297 × 420 mm · PDF Hugo, A3, dark preview Dark · A3 297 × 420 mm · PDF Hugo, A3, ink saver preview Ink saver · A3 297 × 420 mm · PDF
Hugo, A3 landscape, light preview Light · A3 landscape 420 × 297 mm · PDF Hugo, A3 landscape, dark preview Dark · A3 landscape 420 × 297 mm · PDF Hugo, A3 landscape, ink saver preview Ink saver · A3 landscape 420 × 297 mm · PDF
Hugo, Letter, light preview Light · Letter 8.5 × 11 in · PDF Hugo, Letter, dark preview Dark · Letter 8.5 × 11 in · PDF Hugo, Letter, ink saver preview Ink saver · Letter 8.5 × 11 in · PDF
Hugo, Tabloid, light preview Light · Tabloid 11 × 17 in · PDF Hugo, Tabloid, dark preview Dark · Tabloid 11 × 17 in · PDF Hugo, Tabloid, ink saver preview Ink saver · Tabloid 11 × 17 in · PDF

Start here

hugo new site <name>
Create a project
hugo new content posts/<name>.md
Add a page
hugo server -D
Preview with drafts
hugo list drafts
Find unpublished pages
hugo
Build into public/
hugo --minify
Build, smaller output
hugo config
Show merged config
hugo mod get -u
Update modules

Concepts

  1. content/ + hugo.toml Markdown and config
  2. Live preview localhost:1313, reloads
  3. public/ static HTML, CSS, JS
  4. Web host any static host

Project

hugo new site <name>
Create a new site skeleton
hugo new site <name> --format yaml
Use YAML (or json) config
hugo new site . --force
Initialise in a non-empty folder
hugo new theme <name>
Scaffold a theme in themes/
git submodule add <url> themes/<name>
Install a theme as submodule
Then set theme = '<name>' in hugo.toml.
hugo version
Show the installed version
hugo env
Show version and Go/OS info
hugo config
Print the merged site config
hugo config --format yaml
Print config as yaml or json
hugo config mounts
Print the file mounts

Content

hugo new content <path>
Create a page from an archetype
hugo new content posts/<name>.md
Add a post
hugo new content -k <kind> <path>
Force an archetype kind
hugo new content --editor <ed> <path>
Open it in an editor
hugo list drafts
List draft pages
hugo list future
List pages with a future date
hugo list expired
List expired pages
hugo list published
List pages that will be built
hugo list all
List all pages, any state
hugo convert toYAML
Convert front matter to YAML
Also toTOML and toJSON. Writes in place unless -o is set; commit first.
hugo convert toTOML -o <dir>
Convert into another directory

Dev server

hugo server
Serve and live reload
hugo server -D
Include drafts
hugo server -F
Include future-dated pages
hugo server -p <port>
Listen on another port
hugo server --bind 0.0.0.0
Reachable from other devices
hugo server --bind 0.0.0.0 -b http://<ip>:1313
Phone test with matching baseURL
hugo server -N
Jump to the changed page
hugo server -O
Open the browser on start
hugo server --disableFastRender
Full rebuild on each change
hugo server --navigateToChanged --noHTTPCache
Avoid stale browser cache
hugo server --renderToMemory
Do not write to disk
hugo server --poll 700ms
Poll files (network drives)
hugo server --tlsAuto
Serve HTTPS locally
Run hugo server trust once to install the local CA.

Build

hugo
Build the site into public/
hugo --minify
Minify HTML, CSS, JS, XML
hugo -d <dir>
Write to another directory
hugo -b <url>
Set the base URL
hugo -s <dir>
Build a site elsewhere
hugo --gc
Remove unused cache files
hugo --cleanDestinationDir
Remove stale files from output
hugo -D
Build drafts too
hugo -e <env>
Pick the environment
hugo --enableGitInfo
Use git for lastmod and author
hugo --logLevel info
Set log verbosity
hugo --quiet
Hide non-error output
hugo --panicOnWarning
Fail on the first warning
hugo --templateMetrics
Show template timings
hugo --printPathWarnings
Warn on duplicate target paths
hugo --printUnusedTemplates
Warn about unused templates
hugo --ignoreCache
Skip the resource cache

Modules

hugo mod init <path>
Make the site a Hugo module
hugo mod get <path>
Add or fetch a module
hugo mod get <path>@<ver>
Pin a module version
hugo mod get -u
Update all modules
hugo mod tidy
Prune go.mod and go.sum
hugo mod graph
Print the dependency graph
hugo mod vendor
Copy modules into _vendor/
hugo mod verify
Check module checksums
hugo mod clean
Clear the module cache

Deploy and extras

hugo deploy
Upload public/ to a configured target
Needs the deploy edition and a [deployment] block in the config.
hugo deploy --dryRun
Show what would change
hugo deploy --target <name>
Choose a deployment target
hugo completion bash
Generate shell completions
hugo import jekyll <src> <dest>
Import a Jekyll site

Recipes

New site with a theme
hugo new site blogcd bloggit initgit submodule add <theme-url> themes/<theme>echo "theme = '<theme>'" >> hugo.tomlhugo server -D
Write and publish a post
hugo new content posts/first.md# edit it, set draft = falsehugo list draftshugo --minify --gc --cleanDestinationDir
Clean production build
hugo --gc --minify --cleanDestinationDir \  -b https://example.com/ -d public
Preview on a phone
hugo server --bind 0.0.0.0 -D \  -b http://192.168.1.20:1313 --appendPort=false