2021-10-19 09:59:12 -04:00
< a href = "https://gohugo.io/" > < img src = "https://raw.githubusercontent.com/gohugoio/gohugoioTheme/master/static/images/hugo-logo-wide.svg?sanitize=true" alt = "Hugo" width = "565" > < / a >
2015-03-04 09:15:03 -05:00
2022-08-22 13:45:15 -04:00
A Fast and Flexible Static Site Generator built with love by [bep ](https://github.com/bep ), [spf13 ](https://spf13.com/ ) and [friends ](https://github.com/gohugoio/hugo/graphs/contributors ) in [Go ](https://go.dev/ ).
2015-03-04 09:17:35 -05:00
2016-03-02 13:54:56 -05:00
[Website ](https://gohugo.io ) |
2017-06-17 04:06:49 -04:00
[Forum ](https://discourse.gohugo.io ) |
2018-10-09 19:46:48 -04:00
[Documentation ](https://gohugo.io/getting-started/ ) |
[Installation Guide ](https://gohugo.io/getting-started/installing/ ) |
2016-03-12 18:35:06 -05:00
[Contribution Guide ](CONTRIBUTING.md ) |
2018-08-08 04:07:31 -04:00
[Twitter ](https://twitter.com/gohugoio )
2015-03-04 09:15:03 -05:00
2017-06-13 13:00:10 -04:00
[](https://godoc.org/github.com/gohugoio/hugo)
2020-12-23 03:26:23 -05:00
[](https://github.com/gohugoio/hugo/actions?query=workflow%3ATest)
2017-06-13 13:00:10 -04:00
[](https://goreportcard.com/report/github.com/gohugoio/hugo)
2015-03-04 09:06:38 -05:00
2022-08-19 13:15:58 -04:00
* [Overview ](#overview )
2022-09-14 04:20:57 -04:00
* [Banner Sponsors ](#banner-sponsors )
2022-08-19 13:15:58 -04:00
* [Supported Architectures ](#supported-architectures )
* [Choose How to Install ](#choose-how-to-install )
* [Install Hugo as Your Site Generator (Binary Install) ](#install-hugo-as-your-site-generator-binary-install )
2022-11-15 12:19:16 -05:00
* [Build and Install the Binary from Source (Using the Go toolchain) ](#build-and-install-the-binary-from-source-using-the-go-toolchain )
2022-08-19 13:15:58 -04:00
* [The Hugo Documentation ](#the-hugo-documentation )
* [Contributing to Hugo ](#contributing-code-to-hugo )
* [Dependencies ](#dependencies )
2022-08-19 13:12:04 -04:00
2013-07-04 11:34:22 -04:00
## Overview
2022-08-22 13:45:15 -04:00
Hugo is a static HTML and CSS website generator written in [Go ](https://go.dev/ ).
2017-10-05 06:44:43 -04:00
It is optimized for speed, ease of use, and configurability.
2015-10-19 18:53:22 -04:00
Hugo takes a directory with content and templates and renders them into a full HTML website.
2013-07-04 11:34:22 -04:00
2017-10-05 06:44:43 -04:00
Hugo relies on Markdown files with front matter for metadata, and you can run Hugo from any directory.
2015-10-19 18:53:22 -04:00
This works well for shared hosts and other systems where you don’
2013-07-04 11:34:22 -04:00
2015-10-19 18:53:22 -04:00
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.
2013-08-03 03:31:25 -04:00
2017-10-05 06:44:43 -04:00
Hugo is designed to work well for any kind of website including blogs, tumbles, and docs.
2013-07-04 11:34:22 -04:00
2022-09-14 04:20:57 -04:00
## Banner Sponsors
< p > < / p >
< p float = "left" >
2023-01-24 09:04:06 -05:00
< a href = "https://www.linode.com/?utm_campaign=hugosponsor&utm_medium=banner&utm_source=hugogithub" target = "_blank" > < img src = "https://raw.githubusercontent.com/gohugoio/gohugoioTheme/master/assets/images/sponsors/linode-logo_standard_light_medium.png" width = "200" alt = "Linode" > < / a >
< a href = "https://buttercms.com/hugo-cms/?utm_campaign=sponsorship&utm_medium=banner&utm_source=hugogithub" target = "_blank" > < img src = "https://raw.githubusercontent.com/gohugoio/gohugoioTheme/master/assets/images/sponsors/butter-dark.svg?sanitize=true" width = "280" alt = "ButterCMS" > < / a >
2023-01-09 08:13:30 -05:00
2023-03-30 04:19:35 -04:00
< a href = "https://bep.is/en/hugo-sponsor-2023-01/" target = "_blank" > < img src = "https://raw.githubusercontent.com/gohugoio/gohugoioTheme/master/assets/images/sponsors/your-company-dark.svg?sanitize=true" width = "160" alt = "Your Company" > < / a >
2022-09-14 04:20:57 -04:00
< / p >
< p > < / p >
2022-08-19 13:12:43 -04:00
## Supported Architectures
2013-07-04 11:34:22 -04:00
2021-10-17 15:23:01 -04:00
Currently, we provide pre-built Hugo binaries for Windows, Linux, FreeBSD, NetBSD, DragonFly BSD, OpenBSD, macOS (Darwin), and [Android ](https://gist.github.com/bep/a0d8a26cf6b4f8bc992729b8e50b480b ) for x64, i386 and ARM architectures.
2015-02-21 15:42:15 -05:00
2019-10-04 14:55:10 -04:00
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.
2013-07-05 00:35:11 -04:00
2018-10-09 19:46:48 -04:00
**Complete documentation is available at [Hugo Documentation ](https://gohugo.io/getting-started/ ).**
2013-07-05 00:35:11 -04:00
2015-02-01 00:00:18 -05:00
## Choose How to Install
2013-07-24 11:43:23 -04:00
2015-10-19 18:53:22 -04:00
If you want to use Hugo as your site generator, simply install the Hugo binaries.
2013-07-04 11:34:22 -04:00
2017-06-13 13:00:10 -04:00
To contribute to the Hugo source code or documentation, you should [fork the Hugo GitHub project ](https://github.com/gohugoio/hugo#fork-destination-box ) and clone it to your local machine.
2013-07-04 11:34:22 -04:00
2016-02-04 12:25:41 -05:00
Finally, you can install the Hugo source code with `go` , build the binaries yourself, and run Hugo that way.
2015-10-19 18:53:22 -04:00
Building the binaries is an easy task for an experienced `go` getter.
2013-07-04 11:34:22 -04:00
2015-02-01 00:00:18 -05:00
### Install Hugo as Your Site Generator (Binary Install)
2015-02-21 15:42:15 -05:00
2018-10-09 19:46:48 -04:00
Use the [installation instructions in the Hugo documentation ](https://gohugo.io/getting-started/installing/ ).
2013-07-04 13:03:16 -04:00
2022-11-10 11:36:31 -05:00
### Build and Install the Binary from Source (Using the Go toolchain)
2013-07-24 11:43:23 -04:00
2018-03-23 12:34:45 -04:00
#### Prerequisite Tools
2013-07-24 11:27:03 -04:00
2022-03-16 08:20:30 -04:00
* [Go (we test it with the last 2 major versions; but note that Hugo 0.95.0 only builds with >= Go 1.18.) ](https://golang.org/dl/ )
2018-03-23 12:34:45 -04:00
#### Fetch from GitHub
2022-11-10 11:36:31 -05:00
To fetch, build and install from the Github source:
2018-08-29 08:17:47 -04:00
2018-03-23 12:34:45 -04:00
```bash
2022-11-10 11:36:31 -05:00
go install github.com/gohugoio/hugo@latest
2018-03-23 12:34:45 -04:00
```
2020-06-23 10:48:16 -04:00
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:
```bash
2022-11-10 11:36:31 -05:00
CGO_ENABLED=1 go install --tags extended github.com/gohugoio/hugo@latest
2020-06-23 10:48:16 -04:00
```
2017-07-18 04:50:59 -04:00
## The Hugo Documentation
2017-08-10 11:19:36 -04:00
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:
2017-07-18 04:50:59 -04:00
```bash
2017-08-10 11:19:36 -04:00
git clone git@github.com:gohugoio/hugo.git
2017-07-18 04:50:59 -04:00
```
2022-08-19 13:12:04 -04:00
## Contributing code to Hugo
2015-03-04 09:01:15 -05:00
2016-03-12 18:35:06 -05:00
For a complete guide to contributing to Hugo, see the [Contribution Guide ](CONTRIBUTING.md ).
2015-03-04 09:01:15 -05:00
2016-03-12 18:35:06 -05:00
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.
2015-03-04 09:01:15 -05:00
2017-06-13 13:00:10 -04:00
The Hugo community and maintainers are [very active ](https://github.com/gohugoio/hugo/pulse/monthly ) and helpful, and the project benefits greatly from this activity.
2014-11-05 20:01:03 -05:00
2022-08-19 13:12:04 -04:00
## Asking Support Questions
2014-11-05 20:01:03 -05:00
2017-06-17 04:06:49 -04:00
We have an active [discussion forum ](https://discourse.gohugo.io ) where users and developers can ask questions.
2017-04-05 12:41:23 -04:00
Please don't use the GitHub issue tracker to ask questions.
2014-11-05 20:01:03 -05:00
2022-08-19 13:12:04 -04:00
## Reporting Issues
2014-11-05 20:01:03 -05:00
2016-03-12 18:35:06 -05:00
If you believe you have found a defect in Hugo or its documentation, use
2017-04-05 12:41:23 -04:00
the GitHub issue tracker to report the problem to the Hugo maintainers.
2017-06-17 04:06:49 -04:00
If you're not sure if it's a bug or not, start by asking in the [discussion forum ](https://discourse.gohugo.io ).
2016-03-12 18:35:06 -05:00
When reporting the issue, please provide the version of Hugo in use (`hugo version`).
2015-02-21 15:42:15 -05:00
2018-11-27 18:08:27 -05:00
## Dependencies
2021-05-03 09:55:28 -04:00
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.
2023-03-10 14:18:41 -05:00
In Hugo 0.111.2 that list is, in lexical order:
2021-05-03 09:55:28 -04:00
2021-11-03 12:15:33 -04:00
```
2022-06-13 07:16:45 -04:00
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"
2021-05-03 09:55:28 -04:00
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"
2023-03-11 04:15:16 -05:00
github.com/alecthomas/chroma/v2="v2.5.0"
2021-05-03 09:55:28 -04:00
github.com/armon/go-radix="v1.0.0"
2022-06-13 07:16:45 -04:00
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"
2021-05-03 09:55:28 -04:00
github.com/bep/debounce="v1.2.0"
github.com/bep/gitmap="v1.1.2"
2022-06-13 07:16:45 -04:00
github.com/bep/goat="v0.5.0"
2023-03-11 04:15:16 -05:00
github.com/bep/godartsass="v0.16.0"
2022-06-13 07:16:45 -04:00
github.com/bep/golibsass="v1.1.0"
2023-03-11 04:15:16 -05:00
github.com/bep/gowebp="v0.2.0"
github.com/bep/lazycache="v0.2.0"
2022-06-13 07:16:45 -04:00
github.com/bep/overlayfs="v0.6.0"
2021-05-03 09:55:28 -04:00
github.com/bep/tmc="v0.5.1"
2023-03-11 04:15:16 -05:00
github.com/clbanning/mxj/v2="v2.5.7"
2021-05-03 09:55:28 -04:00
github.com/cli/safeexec="v1.0.0"
2023-03-11 04:15:16 -05:00
github.com/cpuguy83/go-md2man/v2="v2.0.2"
2021-05-03 09:55:28 -04:00
github.com/disintegration/gift="v1.2.1"
2023-03-11 04:15:16 -05:00
github.com/dlclark/regexp2="v1.7.0"
2021-05-03 09:55:28 -04:00
github.com/dustin/go-humanize="v1.0.0"
2023-03-11 04:15:16 -05:00
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"
2021-05-03 09:55:28 -04:00
github.com/ghodss/yaml="v1.0.0"
github.com/go-openapi/jsonpointer="v0.19.5"
github.com/go-openapi/swag="v0.19.5"
2023-03-11 04:15:16 -05:00
github.com/gobuffalo/flect="v0.3.0"
2021-05-03 09:55:28 -04:00
github.com/gobwas/glob="v0.2.3"
github.com/gohugoio/go-i18n/v2="v2.1.3-0.20210430103248-4c28c89f8013"
2021-11-03 12:15:33 -04:00
github.com/gohugoio/locales="v0.14.0"
2022-06-13 07:16:45 -04:00
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"
2021-05-03 09:55:28 -04:00
github.com/golang/protobuf="v1.5.2"
2023-03-11 04:15:16 -05:00
github.com/google/go-cmp="v0.5.9"
2022-06-13 07:16:45 -04:00
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"
2023-03-11 04:15:16 -05:00
github.com/hashicorp/golang-lru/v2="v2.0.1"
github.com/invopop/yaml="v0.1.0"
2021-05-03 09:55:28 -04:00
github.com/jdkato/prose="v1.2.1"
github.com/jmespath/go-jmespath="v0.4.0"
2023-03-11 04:15:16 -05:00
github.com/kr/pretty="v0.3.1"
2022-06-13 07:16:45 -04:00
github.com/kr/text="v0.2.0"
2023-03-11 04:15:16 -05:00
github.com/kyokomi/emoji/v2="v2.2.11"
2021-05-03 09:55:28 -04:00
github.com/mailru/easyjson="v0.0.0-20190626092158-b2ccc519800e"
2023-03-11 04:15:16 -05:00
github.com/marekm4/color-extractor="v1.2.0"
2021-05-03 09:55:28 -04:00
github.com/mattn/go-ieproxy="v0.0.1"
2023-03-11 04:15:16 -05:00
github.com/mattn/go-isatty="v0.0.17"
2021-05-03 09:55:28 -04:00
github.com/mattn/go-runewidth="v0.0.9"
2021-11-03 12:15:33 -04:00
github.com/mitchellh/hashstructure="v1.1.0"
2022-06-13 07:16:45 -04:00
github.com/mitchellh/mapstructure="v1.5.0"
2023-03-11 04:15:16 -05:00
github.com/mohae/deepcopy="v0.0.0-20170929034955-c48cc78d4826"
2021-05-03 09:55:28 -04:00
github.com/muesli/smartcrop="v0.3.0"
2023-03-11 04:15:16 -05:00
github.com/niklasfasching/go-org="v1.6.5"
2021-05-03 09:55:28 -04:00
github.com/olekukonko/tablewriter="v0.0.5"
2023-03-11 04:15:16 -05:00
github.com/pelletier/go-toml/v2="v2.0.6"
github.com/rogpeppe/go-internal="v1.9.0"
2022-06-13 07:16:45 -04:00
github.com/russross/blackfriday/v2="v2.1.0"
2021-05-03 09:55:28 -04:00
github.com/rwcarlsen/goexif="v0.0.0-20190401172101-9e8deecbddbd"
2022-06-13 07:16:45 -04:00
github.com/sanity-io/litter="v1.5.5"
2021-11-03 12:15:33 -04:00
github.com/sass/libsass="3.6.5"
2023-03-11 04:15:16 -05:00
github.com/spf13/afero="v1.9.3"
2022-06-13 07:16:45 -04:00
github.com/spf13/cast="v1.5.0"
2023-03-11 04:15:16 -05:00
github.com/spf13/cobra="v1.6.1"
2021-05-03 09:55:28 -04:00
github.com/spf13/fsync="v0.9.0"
github.com/spf13/jwalterweatherman="v1.1.0"
github.com/spf13/pflag="v1.0.5"
2023-03-11 04:15:16 -05:00
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"
2022-06-13 07:16:45 -04:00
gocloud.dev="v0.24.0"
2023-03-11 04:15:16 -05:00
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"
2022-06-13 07:16:45 -04:00
google.golang.org/api="v0.76.0"
google.golang.org/genproto="v0.0.0-20220426171045-31bebdecfb46"
google.golang.org/grpc="v1.46.0"
2023-03-11 04:15:16 -05:00
google.golang.org/protobuf="v1.28.1"
2021-05-03 09:55:28 -04:00
gopkg.in/yaml.v2="v2.4.0"
2023-03-11 04:15:16 -05:00
gopkg.in/yaml.v3="v3.0.1"
2021-11-03 12:15:33 -04:00
```
