The world’s fastest framework for building websites.
Find a file
Mai-Lapyst cc14c6a52c
resources/page: Allow section and taxonomy pages to have a permalink configuration
Allows using permalink configuration for sections (branch bundles) and
also for taxonomy pages. Extends the current permalink configuration to
be able to specified per page kind while also staying backward compatible:
all permalink patterns not dedicated to a certain kind, get automatically
added for both normal pages and term pages.

Fixes #8523
2023-06-26 15:31:01 +02:00
.circleci circleci: Add github.com to known hosts 2023-05-23 10:12:16 +02:00
.github Fix broken nodeploy setup 2023-06-23 12:40:43 +02:00
bufferpool all: gofmt -w -r 'interface{} -> any' . 2022-03-17 22:03:27 +01:00
cache all: Fix typos in function names and comments 2023-06-19 09:26:29 +02:00
codegen Misc doc, code refactoring to improve documentation 2023-01-04 18:01:26 +01:00
commands commands: Enable format flag with hugo new site 2023-06-24 20:26:54 +02:00
common releaser: Prepare repository for 0.115.0-DEV 2023-06-19 17:12:27 +00:00
compare Add page fragments support to Related 2023-02-21 17:56:41 +01:00
config resources/page: Allow section and taxonomy pages to have a permalink configuration 2023-06-26 15:31:01 +02:00
create Create a struct with all of Hugo's config options 2023-05-16 18:01:29 +02:00
deploy Fix broken nodeploy setup 2023-06-23 12:40:43 +02:00
deps Replace the old log setup, with structured logging etc. 2023-06-18 13:03:04 +02:00
docs docs: Regen docshelper 2023-06-19 17:52:52 +02:00
docshelper all: gofmt -w -r 'interface{} -> any' . 2022-03-17 22:03:27 +01:00
helpers helpers: Remove superflous formatting flag in deprecation warnings 2023-06-19 13:02:47 +02:00
htesting all: Fix typos in function names and comments 2023-06-19 09:26:29 +02:00
hugofs resources/page: Allow section and taxonomy pages to have a permalink configuration 2023-06-26 15:31:01 +02:00
hugolib resources/page: Allow section and taxonomy pages to have a permalink configuration 2023-06-26 15:31:01 +02:00
identity all: Fix comments for exported functions and packages 2023-05-18 21:25:27 +02:00
langs all: Fix typos in function names and comments 2023-06-19 09:26:29 +02:00
lazy all: Fix comments for exported functions and packages 2023-05-18 21:25:27 +02:00
livereload all: Fix typos in function names and comments 2023-06-19 09:26:29 +02:00
markup Replace the old log setup, with structured logging etc. 2023-06-18 13:03:04 +02:00
media Create a struct with all of Hugo's config options 2023-05-16 18:01:29 +02:00
metrics Only invoke a given cached partial once 2023-01-25 17:35:23 +01:00
minifiers minifiers: Make sure JS.Version always has a value 2023-05-24 12:42:56 +02:00
modules Replace the old log setup, with structured logging etc. 2023-06-18 13:03:04 +02:00
navigation Create a struct with all of Hugo's config options 2023-05-16 18:01:29 +02:00
output Fix regression when config for OutputFormat.BaseName is an empty string 2023-05-23 19:23:39 +02:00
parser Replace the old log setup, with structured logging etc. 2023-06-18 13:03:04 +02:00
publisher Create a struct with all of Hugo's config options 2023-05-16 18:01:29 +02:00
related Create a struct with all of Hugo's config options 2023-05-16 18:01:29 +02:00
releaser Remove reference to Goreleaser in code comment 2023-01-03 20:25:44 +01:00
resources resources/page: Allow section and taxonomy pages to have a permalink configuration 2023-06-26 15:31:01 +02:00
scripts/fork_go_templates Replace deprecated ioutil with io and os 2023-03-01 16:28:43 +01:00
snap snap: Switch from Embedded Dart Sass to Dart Sass (#11146) 2023-06-21 15:39:02 -07:00
source resources/page: Allow section and taxonomy pages to have a permalink configuration 2023-06-26 15:31:01 +02:00
testscripts commands: Enable format flag with hugo new site 2023-06-24 20:26:54 +02:00
tpl tpl/tplimpl: Fix typo in global variable name 2023-06-26 15:12:21 +02:00
transform Replace the old log setup, with structured logging etc. 2023-06-18 13:03:04 +02:00
watcher Run gofmt -s on source files 2023-03-12 10:32:29 +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 Create a struct with all of Hugo's config options 2023-05-16 18:01:29 +02: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
bench.sh Add GOEXE to support building with different versions of go 2017-07-16 00:35:15 +02:00
benchbep.sh Add Hugo Modules 2019-07-24 09:35:53 +02:00
benchSite.sh all: Fix minor typos 2020-12-16 12:11:32 +01:00
bepdock.sh build: Update the temp docker script 2018-09-24 12:41:12 +02:00
CONTRIBUTING.md Update CONTRIBUTING.md 2023-01-31 08:08:52 +01:00
Dockerfile Update Go and Alpine version in Dockerfile 2022-10-19 19:58:25 +02:00
go.mod build(deps): bump github.com/niklasfasching/go-org from 1.6.6 to 1.7.0 2023-06-23 12:17:35 +02:00
go.sum build(deps): bump github.com/niklasfasching/go-org from 1.6.6 to 1.7.0 2023-06-23 12:17:35 +02:00
hugoreleaser.env releaser: Prepare repository for 0.115.0-DEV 2023-06-19 17:12:27 +00:00
hugoreleaser.toml all: Fix some typos 2023-06-19 09:28:10 +02:00
LICENSE license: Add copyright info 2022-08-28 12:55:47 +02:00
magefile.go github: Fix Windows build 2023-06-01 09:54:40 +02:00
main.go Fix some recently introduced error handling issues 2023-05-18 12:47:23 +02:00
main_test.go all: Replace deprecated ioutil with io and os 2023-06-01 17:52:21 +02: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
README.md Update README.md 2023-06-24 11:28:29 +02:00
release-hook-post-linux.sh Add linux/arm64 extended to release setup 2022-08-28 18:23:01 +02:00
SECURITY.md Update SECURITY.md 2020-12-22 10:09:59 +01:00
watchtestscripts.sh Create a struct with all of Hugo's config options 2023-05-16 18:01:29 +02:00

Hugo

A Fast and Flexible Static Site Generator built with love by bep, spf13 and friends in Go.

Website | Forum | Documentation | Installation Guide | Contribution Guide | Twitter

GoDoc Tests on Linux, MacOS and Windows Go Report Card

Overview

Hugo is a static HTML and CSS website generator written in Go. It is optimized for speed, ease of use, and configurability. Hugo takes a directory with content and templates and renders them into a full HTML website.

Hugo relies on Markdown files with front matter for metadata, and you can run Hugo from any directory. This works well for shared hosts and other systems where you dont have a privileged account.

Hugo renders a typical website of moderate size in a fraction of a second. A good rule of thumb is that each piece of content renders in around 1 millisecond.

Hugo is designed to work well for any kind of website including blogs, tumbles, and docs.

Banner Sponsors

 

Linode           CloudCannon

 

Supported Architectures

Currently, we provide pre-built Hugo binaries for Windows, Linux, FreeBSD, NetBSD, DragonFly BSD, OpenBSD, macOS (Darwin), and Android for x64, i386 and ARM architectures.

Hugo may also be compiled from source wherever the Go compiler tool chain can run, e.g. for other operating systems including Plan 9 and Solaris.

Complete documentation is available at Hugo Documentation.

Choose How to Install

If you want to use Hugo as your site generator, simply install the Hugo binaries.

To contribute to the Hugo source code or documentation, you should fork the Hugo GitHub project and clone it to your local machine.

Finally, you can install the Hugo source code with go, build the binaries yourself, and run Hugo that way. Building the binaries is an easy task for an experienced go getter.

Install Hugo as Your Site Generator (Binary Install)

Use the installation instructions in the Hugo documentation.

Build and Install the Binary from Source (Using the Go toolchain)

Prerequisite Tools

Fetch from GitHub

To fetch, build and install from the Github source:

go install github.com/gohugoio/hugo@latest

If you want to compile with Sass/SCSS support use -tags extended and make sure CGO_ENABLED=1 is set in your go environment. If you don't want to have CGO enabled, you may use the following command to temporarily enable CGO only for hugo compilation:

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

The Hugo Documentation

The Hugo documentation now lives in its own repository, see https://github.com/gohugoio/hugoDocs. But we do keep a version of that documentation as a git subtree in this repository. To build the sub folder /docs as a Hugo site, you need to clone this repo:

git clone git@github.com:gohugoio/hugo.git

Contributing code to Hugo

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

We welcome contributions to Hugo of any kind including documentation, themes, organization, tutorials, blog posts, bug reports, issues, feature requests, feature implementations, pull requests, answering questions on the forum, helping to manage issues, etc.

The Hugo community and maintainers are very active and helpful, and the project benefits greatly from this activity.

Asking Support Questions

We have an active discussion forum where users and developers can ask questions. Please don't use the GitHub issue tracker to ask questions.

Reporting Issues

If you believe you have found a defect in Hugo or its documentation, use the GitHub issue tracker to report the problem to the Hugo maintainers. If you're not sure if it's a bug or not, start by asking in the discussion forum. When reporting the issue, please provide the version of Hugo in use (hugo version).

Dependencies

Hugo stands on the shoulder of many great open source libraries.

If you run hugo env -v you will get a complete and up to date list.

In Hugo 0.111.2 that list is, in lexical order:

cloud.google.com/go/compute="v1.6.1"
cloud.google.com/go/iam="v0.3.0"
cloud.google.com/go/storage="v1.22.0"
cloud.google.com/go="v0.101.0"
github.com/Azure/azure-pipeline-go="v0.2.3"
github.com/Azure/azure-storage-blob-go="v0.14.0"
github.com/Azure/go-autorest/autorest/adal="v0.9.15"
github.com/Azure/go-autorest/autorest/date="v0.3.0"
github.com/Azure/go-autorest/autorest="v0.11.20"
github.com/Azure/go-autorest/logger="v0.2.1"
github.com/Azure/go-autorest/tracing="v0.6.0"
github.com/BurntSushi/locker="v0.0.0-20171006230638-a6e239ea1c69"
github.com/PuerkitoBio/purell="v1.1.1"
github.com/PuerkitoBio/urlesc="v0.0.0-20170810143723-de5bf2ad4578"
github.com/alecthomas/chroma/v2="v2.5.0"
github.com/armon/go-radix="v1.0.0"
github.com/aws/aws-sdk-go-v2/config="v1.7.0"
github.com/aws/aws-sdk-go-v2/credentials="v1.4.0"
github.com/aws/aws-sdk-go-v2/feature/ec2/imds="v1.5.0"
github.com/aws/aws-sdk-go-v2/internal/ini="v1.2.2"
github.com/aws/aws-sdk-go-v2/service/internal/presigned-url="v1.3.0"
github.com/aws/aws-sdk-go-v2/service/sso="v1.4.0"
github.com/aws/aws-sdk-go-v2/service/sts="v1.7.0"
github.com/aws/aws-sdk-go-v2="v1.9.0"
github.com/aws/aws-sdk-go="v1.43.5"
github.com/aws/smithy-go="v1.8.0"
github.com/bep/clock="v0.3.0"
github.com/bep/debounce="v1.2.0"
github.com/bep/gitmap="v1.1.2"
github.com/bep/goat="v0.5.0"
github.com/bep/godartsass="v0.16.0"
github.com/bep/golibsass="v1.1.0"
github.com/bep/gowebp="v0.2.0"
github.com/bep/lazycache="v0.2.0"
github.com/bep/overlayfs="v0.6.0"
github.com/bep/tmc="v0.5.1"
github.com/clbanning/mxj/v2="v2.5.7"
github.com/cli/safeexec="v1.0.0"
github.com/cpuguy83/go-md2man/v2="v2.0.2"
github.com/disintegration/gift="v1.2.1"
github.com/dlclark/regexp2="v1.7.0"
github.com/dustin/go-humanize="v1.0.0"
github.com/evanw/esbuild="v0.17.0"
github.com/frankban/quicktest="v1.14.4"
github.com/fsnotify/fsnotify="v1.6.0"
github.com/getkin/kin-openapi="v0.110.0"
github.com/ghodss/yaml="v1.0.0"
github.com/go-openapi/jsonpointer="v0.19.5"
github.com/go-openapi/swag="v0.19.5"
github.com/gobuffalo/flect="v0.3.0"
github.com/gobwas/glob="v0.2.3"
github.com/gohugoio/go-i18n/v2="v2.1.3-0.20210430103248-4c28c89f8013"
github.com/gohugoio/locales="v0.14.0"
github.com/gohugoio/localescompressed="v1.0.1"
github.com/golang-jwt/jwt/v4="v4.0.0"
github.com/golang/groupcache="v0.0.0-20210331224755-41bb18bfe9da"
github.com/golang/protobuf="v1.5.2"
github.com/google/go-cmp="v0.5.9"
github.com/google/uuid="v1.3.0"
github.com/google/wire="v0.5.0"
github.com/googleapis/gax-go/v2="v2.3.0"
github.com/googleapis/go-type-adapters="v1.0.0"
github.com/gorilla/websocket="v1.5.0"
github.com/hairyhenderson/go-codeowners="v0.2.3-0.20201026200250-cdc7c0759690"
github.com/hashicorp/golang-lru/v2="v2.0.1"
github.com/invopop/yaml="v0.1.0"
github.com/jdkato/prose="v1.2.1"
github.com/jmespath/go-jmespath="v0.4.0"
github.com/kr/pretty="v0.3.1"
github.com/kr/text="v0.2.0"
github.com/kyokomi/emoji/v2="v2.2.11"
github.com/mailru/easyjson="v0.0.0-20190626092158-b2ccc519800e"
github.com/marekm4/color-extractor="v1.2.0"
github.com/mattn/go-ieproxy="v0.0.1"
github.com/mattn/go-isatty="v0.0.17"
github.com/mattn/go-runewidth="v0.0.9"
github.com/mitchellh/hashstructure="v1.1.0"
github.com/mitchellh/mapstructure="v1.5.0"
github.com/mohae/deepcopy="v0.0.0-20170929034955-c48cc78d4826"
github.com/muesli/smartcrop="v0.3.0"
github.com/niklasfasching/go-org="v1.6.5"
github.com/olekukonko/tablewriter="v0.0.5"
github.com/pelletier/go-toml/v2="v2.0.6"
github.com/rogpeppe/go-internal="v1.9.0"
github.com/russross/blackfriday/v2="v2.1.0"
github.com/rwcarlsen/goexif="v0.0.0-20190401172101-9e8deecbddbd"
github.com/sanity-io/litter="v1.5.5"
github.com/sass/libsass="3.6.5"
github.com/spf13/afero="v1.9.3"
github.com/spf13/cast="v1.5.0"
github.com/spf13/cobra="v1.6.1"
github.com/spf13/fsync="v0.9.0"
github.com/spf13/jwalterweatherman="v1.1.0"
github.com/spf13/pflag="v1.0.5"
github.com/tdewolff/minify/v2="v2.12.4"
github.com/tdewolff/parse/v2="v2.6.5"
github.com/webmproject/libwebp="v1.2.4"
github.com/yuin/goldmark="v1.5.4"
go.opencensus.io="v0.24.0"
go.uber.org/atomic="v1.10.0"
gocloud.dev="v0.24.0"
golang.org/x/crypto="v0.3.0"
golang.org/x/exp="v0.0.0-20221031165847-c99f073a8326"
golang.org/x/image="v0.5.0"
golang.org/x/net="v0.7.0"
golang.org/x/oauth2="v0.2.0"
golang.org/x/sync="v0.1.0"
golang.org/x/sys="v0.5.0"
golang.org/x/text="v0.7.0"
golang.org/x/tools="v0.4.0"
golang.org/x/xerrors="v0.0.0-20220907171357-04be3eba64a2"
google.golang.org/api="v0.76.0"
google.golang.org/genproto="v0.0.0-20220426171045-31bebdecfb46"
google.golang.org/grpc="v1.46.0"
google.golang.org/protobuf="v1.28.1"
gopkg.in/yaml.v2="v2.4.0"
gopkg.in/yaml.v3="v3.0.1"