1
0
Fork 0
The world’s fastest framework for building websites.
 
 
 
Go to file
W. Michael Petullo 4b0c194fb3 Fix build with Go 1.24
Go 1.24 provides stricter checking that forbids passing a variable as
a format string to Printf-family functions with no other arguments. Remove
instances of this. See also:

https://tip.golang.org/doc/go1.24#vet

Signed-off-by: W. Michael Petullo <mike@flyn.org>
2025-01-21 11:10:03 +01:00
.circleci release: Add withdeploy deb extended archives 2024-12-22 16:55:52 +01:00
.github github: Adjust test workflow to install Dart Sass v1.80.3 2024-11-01 13:37:45 +01:00
bufferpool all: gofmt -w -r 'interface{} -> any' . 2022-03-17 22:03:27 +01:00
cache deps: Upgrade github.com/bep/lazycache v0.6.0 => v0.7.0 2024-10-27 12:43:36 +01:00
codegen all: Run gofumpt -l -w . 2024-01-28 23:14:09 +01:00
commands commands: Fix spelling in comment 2025-01-15 22:31:52 +01:00
common Fix build with Go 1.24 2025-01-21 11:10:03 +01:00
compare all: Run gofumpt -l -w . 2024-01-28 23:14:09 +01:00
config resources: Fix 2 image file cache key issues 2025-01-18 12:23:18 +01:00
create create: Respect --noBuildLock in hugo new 2025-01-06 17:59:24 +01:00
deploy Build without the deploy feature by default 2024-10-30 11:46:40 +01:00
deps Fix NPX issue with TailwindCSS v4 2025-01-07 13:12:08 +01:00
docs Merge commit '81a7b6390036138356773c87a886679c81c524e1' 2025-01-16 10:35:07 +01:00
docshelper Add all config to docshelper.json 2023-08-07 13:42:54 +02:00
helpers Add Page.Contents with scope support 2024-08-29 16:45:21 +02:00
htesting tpl/tplimpl: Simplify some test assertions 2025-01-16 11:29:24 +01:00
hugofs Fix same resource file published more than once 2024-12-27 18:55:24 +01:00
hugolib resources: Fix 2 image file cache key issues 2025-01-18 12:23:18 +01:00
identity Add js.Batch 2024-12-12 21:43:17 +01:00
internal js/esbuild: Don't try to resolve packages in /assets marked as external 2024-12-22 21:29:18 +01:00
langs Create pages from _content.gotmpl 2024-05-14 13:12:08 +02:00
lazy Add js.Batch 2024-12-12 21:43:17 +01:00
livereload livereload: Improve the livereload script build and update to v4.0.2 2024-05-10 22:33:08 +02:00
markup Fix NPX issue with TailwindCSS v4 2025-01-07 13:12:08 +01:00
media Add js.Batch 2024-12-12 21:43:17 +01:00
metrics Consolidate all hashing to the common/hashing package 2024-07-31 16:44:06 +02:00
minifiers minifiers: Add failing test for upstream bug 2024-11-23 15:11:09 +01:00
modules Fix NPX issue with TailwindCSS v4 2025-01-07 13:12:08 +01:00
navigation content adapter: Add support for menus in AddPage 2024-05-30 11:29:21 +02:00
output output: Fix docshelper template lookup order for AMP pages 2024-08-28 13:05:28 +02:00
parser parser/pageparser: Fix Org Mode summary delimiter assignment 2024-12-16 10:30:27 +01:00
publisher all: Run gofumpt -l -w . 2024-01-28 23:14:09 +01:00
related all: Run gofumpt -l -w . 2024-01-28 23:14:09 +01:00
releaser Revert "Adjust Circleci workflow to make the Docker images build" 2024-08-26 15:56:39 +02:00
resources resources: Fix 2 image file cache key issues 2025-01-18 12:23:18 +01:00
scripts docker: Fix Dart Sass ARM64 arch mismatch, /cache permissions 2024-10-17 15:42:41 +02:00
snap snap: Always package latest stable version of Go 2025-01-06 12:50:40 -08:00
source Remove deprecations <= v0.122.0 (note) 2024-11-16 20:32:43 +01:00
testscripts Fix same resource file published more than once 2024-12-27 18:55:24 +01:00
tpl tpl/tplimpl: Fix context in shortcode error messages 2025-01-20 16:17:55 +01:00
transform all: Rework page store, add a dynacache, improve partial rebuilds, and some general spring cleaning 2024-01-27 16:28:14 +01:00
watcher all: Fix typos and some URLs 2024-02-18 12:16:30 +01:00
.dockerignore Support Docker args TAGS, WORKDIR, CGO; speed up repetitive builds 2019-02-22 11:53:17 -08:00
.gitattributes .gitattributes: Exclude *.svg from CRLF/LF conversion 2018-07-09 21:06:15 -06:00
.gitignore images: Rework the golden tests 2025-01-08 17:11:27 +01:00
.gitmodules Remove the theme submodule from /docs 2017-08-10 14:54:19 +02:00
.mailmap Add .mailmap to get a more correct author log 2015-01-28 16:50:36 +01:00
CONTRIBUTING.md docs: Remove outdated note from CONTRIBUTING.md 2023-10-21 18:57:01 +02:00
Dockerfile Build without the deploy feature by default 2024-10-30 11:46:40 +01:00
LICENSE Use Apache License without modification 2024-04-23 09:15:29 +02:00
README.md tpl/images: Add images.QR function 2025-01-06 12:05:59 +01:00
SECURITY.md SECURITY.md: Update link to security model 2024-04-22 13:04:53 +02:00
check_gofmt.sh Create default link and image render hooks 2024-01-30 20:12:19 +01:00
go.mod deps: Upgrade github.com/gohugoio/hashstructure from 0.1.0 to 0.3.0 2025-01-13 16:22:24 +02:00
go.sum deps: Upgrade github.com/gohugoio/hashstructure from 0.1.0 to 0.3.0 2025-01-13 16:22:24 +02:00
hugoreleaser.env releaser: Prepare repository for 0.142.0-DEV 2025-01-16 13:26:52 +00:00
hugoreleaser.yaml release: Add withdeploy deb extended archives 2024-12-22 16:55:52 +01:00
magefile.go Build without the deploy feature by default 2024-10-30 11:46:40 +01:00
main.go all: Rework page store, add a dynacache, improve partial rebuilds, and some general spring cleaning 2024-01-27 16:28:14 +01:00
main_test.go all: Typo fixes 2024-03-15 17:25:52 +01:00
main_withdeploy_off_test.go commands: Print the "deploy not available" error message even if flags provided 2024-11-05 11:40:42 +01:00
main_withdeploy_test.go Build without the deploy feature by default 2024-10-30 11:46:40 +01:00
merge-release.sh Add merge helper 2020-10-08 19:32:53 +02:00
pull-docs.sh Allow the pull-docs script to pull other than master 2017-09-23 10:13:40 +02:00
watchtestscripts.sh all: Fix typos 2024-02-11 13:51:33 +02:00

README.md

Hugo

A fast and flexible static site generator built with love by bep, spf13, and friends in Go.


GoDoc Tests on Linux, MacOS and Windows Go Report Card

Website | Installation | Documentation | Support | Contributing | Mastodon

Overview

Hugo is a static site generator written in Go, optimized for speed and designed for flexibility. With its advanced templating system and fast asset pipelines, Hugo renders a complete site in seconds, often less.

Due to its flexible framework, multilingual support, and powerful taxonomy system, Hugo is widely used to create:

  • Corporate, government, nonprofit, education, news, event, and project sites
  • Documentation sites
  • Image portfolios
  • Landing pages
  • Business, professional, and personal blogs
  • Resumes and CVs

Use Hugo's embedded web server during development to instantly see changes to content, structure, behavior, and presentation. Then deploy the site to your host, or push changes to your Git provider for automated builds and deployment.

Hugo's fast asset pipelines include:

  • Image processing Convert, resize, crop, rotate, adjust colors, apply filters, overlay text and images, and extract EXIF data
  • JavaScript bundling Transpile TypeScript and JSX to JavaScript, bundle, tree shake, minify, create source maps, and perform SRI hashing.
  • Sass processing Transpile Sass to CSS, bundle, tree shake, minify, create source maps, perform SRI hashing, and integrate with PostCSS
  • Tailwind CSS processing Compile Tailwind CSS utility classes into standard CSS, bundle, tree shake, optimize, minify, perform SRI hashing, and integrate with PostCSS

And with Hugo Modules, you can share content, assets, data, translations, themes, templates, and configuration with other projects via public or private Git repositories.

See the features section of the documentation for a comprehensive summary of Hugo's capabilities.

Sponsors

 

Linode     The complete IDE crafted for professional Go developers.

Installation

Install Hugo from a prebuilt binary, package manager, or package repository. Please see the installation instructions for your operating system:

Build from source

Hugo is available in two editions: standard and extended. With the extended edition you can:

  • Encode to the WebP format when processing images. You can decode WebP images with either edition.
  • Transpile Sass to CSS using the embedded LibSass transpiler. The extended edition is not required to use the Dart Sass transpiler.

Prerequisites to build Hugo from source:

  • Standard edition: Go 1.20 or later
  • Extended edition: Go 1.20 or later, and GCC

Build the standard edition:

go install github.com/gohugoio/hugo@latest

Build the extended edition:

CGO_ENABLED=1 go install -tags extended github.com/gohugoio/hugo@latest

Star History

Star History Chart

Documentation

Hugo's documentation includes installation instructions, a quick start guide, conceptual explanations, reference information, and examples.

Please submit documentation issues and pull requests to the documentation repository.

Support

Please do not use the issue queue for questions or troubleshooting. Unless you are certain that your issue is a software defect, use the forum.

Hugos forum is an active community of users and developers who answer questions, share knowledge, and provide examples. A quick search of over 20,000 topics will often answer your question. Please be sure to read about requesting help before asking your first question.

Contributing

You can contribute to the Hugo project by:

Please submit documentation issues and pull requests to the documentation repository.

If you have an idea for an enhancement or new feature, create a new topic on the forum in the "Feature" category. This will help you to:

  • Determine if the capability already exists
  • Measure interest
  • Refine the concept

If there is sufficient interest, create a proposal. Do not submit a pull request until the project lead accepts the proposal.

For a complete guide to contributing to Hugo, see the Contribution Guide.

Dependencies

Hugo stands on the shoulders of great open source libraries. Run hugo env --logLevel info to display a list of dependencies.

See current dependencies
github.com/BurntSushi/locker="v0.0.0-20171006230638-a6e239ea1c69"
github.com/alecthomas/chroma/v2="v2.14.0"
github.com/armon/go-radix="v1.0.1-0.20221118154546-54df44f2176c"
github.com/bep/clocks="v0.5.0"
github.com/bep/debounce="v1.2.0"
github.com/bep/gitmap="v1.6.0"
github.com/bep/goat="v0.5.0"
github.com/bep/godartsass/v2="v2.3.2"
github.com/bep/golibsass="v1.2.0"
github.com/bep/gowebp="v0.3.0"
github.com/bep/imagemeta="v0.8.3"
github.com/bep/lazycache="v0.7.0"
github.com/bep/logg="v0.4.0"
github.com/bep/mclib="v1.20400.20402"
github.com/bep/overlayfs="v0.9.2"
github.com/bep/simplecobra="v0.4.0"
github.com/bep/tmc="v0.5.1"
github.com/cespare/xxhash/v2="v2.3.0"
github.com/clbanning/mxj/v2="v2.7.0"
github.com/cli/safeexec="v1.0.1"
github.com/cpuguy83/go-md2man/v2="v2.0.4"
github.com/disintegration/gift="v1.2.1"
github.com/dlclark/regexp2="v1.11.0"
github.com/evanw/esbuild="v0.24.0"
github.com/fatih/color="v1.18.0"
github.com/frankban/quicktest="v1.14.6"
github.com/fsnotify/fsnotify="v1.8.0"
github.com/getkin/kin-openapi="v0.123.0"
github.com/ghodss/yaml="v1.0.0"
github.com/go-openapi/jsonpointer="v0.20.2"
github.com/go-openapi/swag="v0.22.8"
github.com/gobuffalo/flect="v1.0.3"
github.com/gobwas/glob="v0.2.3"
github.com/gohugoio/go-i18n/v2="v2.1.3-0.20230805085216-e63c13218d0e"
github.com/gohugoio/hashstructure="v0.1.0"
github.com/gohugoio/httpcache="v0.7.0"
github.com/gohugoio/hugo-goldmark-extensions/extras="v0.2.0"
github.com/gohugoio/hugo-goldmark-extensions/passthrough="v0.3.0"
github.com/gohugoio/locales="v0.14.0"
github.com/gohugoio/localescompressed="v1.0.1"
github.com/google/go-cmp="v0.6.0"
github.com/gorilla/websocket="v1.5.3"
github.com/hairyhenderson/go-codeowners="v0.7.0"
github.com/hashicorp/golang-lru/v2="v2.0.7"
github.com/invopop/yaml="v0.2.0"
github.com/jdkato/prose="v1.2.1"
github.com/josharian/intern="v1.0.0"
github.com/kr/pretty="v0.3.1"
github.com/kr/text="v0.2.0"
github.com/kyokomi/emoji/v2="v2.2.13"
github.com/mailru/easyjson="v0.7.7"
github.com/makeworld-the-better-one/dither/v2="v2.4.0"
github.com/marekm4/color-extractor="v1.2.1"
github.com/mattn/go-colorable="v0.1.13"
github.com/mattn/go-isatty="v0.0.20"
github.com/mattn/go-runewidth="v0.0.9"
github.com/mitchellh/mapstructure="v1.5.1-0.20231216201459-8508981c8b6c"
github.com/mohae/deepcopy="v0.0.0-20170929034955-c48cc78d4826"
github.com/muesli/smartcrop="v0.3.0"
github.com/niklasfasching/go-org="v1.7.0"
github.com/olekukonko/tablewriter="v0.0.5"
github.com/pbnjay/memory="v0.0.0-20210728143218-7b4eea64cf58"
github.com/pelletier/go-toml/v2="v2.2.3"
github.com/perimeterx/marshmallow="v1.1.5"
github.com/pkg/browser="v0.0.0-20240102092130-5ac0b6a4141c"
github.com/pkg/errors="v0.9.1"
github.com/rogpeppe/go-internal="v1.13.1"
github.com/russross/blackfriday/v2="v2.1.0"
github.com/sass/dart-sass/compiler="1.81.0"
github.com/sass/dart-sass/implementation="1.81.0"
github.com/sass/dart-sass/protocol="3.1.0"
github.com/sass/libsass="3.6.6"
github.com/spf13/afero="v1.11.0"
github.com/spf13/cast="v1.7.1"
github.com/spf13/cobra="v1.8.1"
github.com/spf13/fsync="v0.10.1"
github.com/spf13/pflag="v1.0.5"
github.com/tdewolff/minify/v2="v2.20.37"
github.com/tdewolff/parse/v2="v2.7.15"
github.com/tetratelabs/wazero="v1.8.2"
github.com/webmproject/libwebp="v1.3.2"
github.com/yuin/goldmark-emoji="v1.0.4"
github.com/yuin/goldmark="v1.7.8"
go.uber.org/automaxprocs="v1.5.3"
golang.org/x/crypto="v0.31.0"
golang.org/x/exp="v0.0.0-20221031165847-c99f073a8326"
golang.org/x/image="v0.22.0"
golang.org/x/mod="v0.22.0"
golang.org/x/net="v0.33.0"
golang.org/x/sync="v0.10.0"
golang.org/x/sys="v0.28.0"
golang.org/x/text="v0.21.0"
golang.org/x/tools="v0.28.0"
google.golang.org/protobuf="v1.35.2"
gopkg.in/yaml.v2="v2.4.0"
gopkg.in/yaml.v3="v3.0.1"
rsc.io/qr="v0.2.0"
software.sslmate.com/src/go-pkcs12="v0.2.0"