The world’s fastest framework for building websites.
Find a file
2021-05-03 15:55:28 +02:00
.circleci build: Add arm64 to Darwinextended build and add vendorInfo 2021-02-18 14:11:48 +01:00
.github github: More explicit support link to discourse 2021-03-14 18:27:15 +01:00
bufferpool tests: Convert from testify to quicktest 2019-08-12 13:26:32 +02:00
cache all: Fix minor typos 2020-12-16 12:11:32 +01:00
codegen all: Fix minor typos 2020-12-16 12:11:32 +01:00
commands commands: Remove all dates from gendoc 2021-05-01 12:03:56 +02:00
common releaser: Prepare repository for 0.84.0-DEV 2021-05-02 15:28:40 +00:00
compare all: Format code with gofumpt 2020-12-03 13:12:58 +01:00
config Squashed 'docs/' changes from d343ebf71..bb15e9804 2021-02-23 17:39:59 +01:00
create Improve LookPath 2020-12-19 17:03:07 +01:00
deploy deploy: Don't treat a NotFound response for Delete as a fatal error. 2021-04-29 07:07:01 +02:00
deps Add Dart Sass support 2020-12-30 17:32:25 +01:00
docs releaser: Add release notes to /docs for release of 0.83.1 2021-05-02 14:38:02 +00:00
docshelper Some minify configuration adjustments 2020-03-20 20:35:57 +01:00
examples examples: Remove unneeded meta tag from blog example 2020-11-24 20:20:04 +01:00
helpers Update emoji import paths and version 2020-12-30 22:46:19 +01:00
htesting Add Dart Sass support 2020-12-30 17:32:25 +01:00
hugofs modules: Add config option modules.vendorClosest 2021-02-16 16:30:01 +01:00
hugolib Make the shortcode template lookup for output formats stable 2021-04-23 15:04:35 +02:00
identity all: Format code with gofumpt 2020-12-03 13:12:58 +01:00
langs langs/i18n: Fix warning regression in i18n 2021-05-02 16:27:22 +02:00
lazy all: Format code with gofumpt 2020-12-03 13:12:58 +01:00
livereload all: Format code with gofumpt 2020-12-03 13:12:58 +01:00
markup org: Disable broken pretty relative links feature 2021-04-12 08:08:53 +02:00
media Regression in media type suffix lookup 2021-04-20 12:52:30 +02:00
metrics all: Format code with gofumpt 2020-12-03 13:12:58 +01:00
minifiers deps: Bump github.com/tdewolff/minify/v2 v2.9.15 2021-03-20 15:51:20 +01:00
modules modules: Add config option modules.vendorClosest 2021-02-16 16:30:01 +01:00
navigation all: Format code with gofumpt 2020-12-03 13:12:58 +01:00
output output: Only output mediaType once in docshelper JSON 2021-04-01 19:05:33 +02:00
parser media: Make Type comparable 2021-03-14 15:21:54 +01:00
publisher publisher: Remove some unreachable code 2021-04-20 17:47:09 +02:00
related all: Format code with gofumpt 2020-12-03 13:12:58 +01:00
releaser Remove duplicate references from release notes 2021-04-15 21:15:20 +02:00
resources resources/page: Fix permalinks pattern detection for some of the sections variants 2021-04-25 16:57:09 +02:00
scripts/fork_go_templates Pull in latest Go 1.16 template source 2021-02-18 14:11:48 +01:00
snap releaser: Prepare repository for 0.84.0-DEV 2021-05-02 15:28:40 +00:00
source all: Fix minor typos 2020-12-16 12:11:32 +01:00
tpl tpl: Fix countwords to handle special chars 2021-05-03 09:10:06 +02:00
transform all: Fix minor typos 2020-12-16 12:11:32 +01:00
watcher watcher: Add file deleted by accident 2020-11-21 17:21:14 +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 Collect HTML elements during the build to use in PurgeCSS etc. 2020-04-09 22:57:26 +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 2021-02-25 11:50:08 +01:00
Dockerfile #8210 Upgrade golang version for Dockerfile 2021-02-28 14:14:06 +01:00
go.mod deps: Update getkin/kin-openapi v0.60.0 => v0.61. 2021-04-30 14:27:21 +02:00
go.sum releaser: Bump versions for release of 0.83.0 2021-05-01 12:10:05 +00:00
goreleaser.yml build: Add arm64 to Darwinextended build and add vendorInfo 2021-02-18 14:11:48 +01:00
LICENSE Add a GitHub compatible Apache 2 license text 2018-04-16 00:03:30 +02:00
magefile.go all: Format code with gofumpt 2020-12-03 13:12:58 +01:00
main.go all: Format code with gofumpt 2020-12-03 13:12:58 +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
README.md readme: Update dependency list 2021-05-03 15:55:28 +02:00
SECURITY.md Update SECURITY.md 2020-12-22 10:09:59 +01: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.

Supported Architectures

Currently, we provide pre-built Hugo binaries for Windows, Linux, FreeBSD, NetBSD, DragonFly BSD, Open BSD, 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. The Hugo binaries have no external dependencies.

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 Binaries from Source (Advanced Install)

Prerequisite Tools

Fetch from GitHub

Since Hugo 0.48, Hugo uses the Go Modules support built into Go 1.11 to build. The easiest is to clone Hugo in a directory outside of GOPATH, as in the following example:

mkdir $HOME/src
cd $HOME/src
git clone https://github.com/gohugoio/hugo.git
cd hugo
go install

If you are a Windows user, substitute the $HOME environment variable above with %USERPROFILE%.

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

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 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).

Submitting Patches

The Hugo project welcomes all contributors and contributions regardless of skill or experience level. If you are interested in helping with the project, we will help you with your contribution. Hugo is a very active project with many contributions happening daily.

We want to create the best possible product for our users and the best contribution experience for our developers, we have a set of guidelines which ensure that all contributions are acceptable. The guidelines are not intended as a filter or barrier to participation. If you are unfamiliar with the contribution process, the Hugo team will help you and teach you how to bring your contribution in accordance with the guidelines.

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

Analytics

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.83.0 that list is, in lexical order:

cloud.google.com/go/storage="v1.10.0"
cloud.google.com/go="v0.81.0"
github.com/Azure/azure-pipeline-go="v0.2.2"
github.com/Azure/azure-storage-blob-go="v0.9.0"
github.com/BurntSushi/locker="v0.0.0-20171006230638-a6e239ea1c69"
github.com/BurntSushi/toml="v0.3.1"
github.com/PuerkitoBio/purell="v1.1.1"
github.com/PuerkitoBio/urlesc="v0.0.0-20170810143723-de5bf2ad4578"
github.com/alecthomas/chroma="v0.9.1"
github.com/armon/go-radix="v1.0.0"
github.com/aws/aws-sdk-go="v1.38.23"
github.com/bep/debounce="v1.2.0"
github.com/bep/gitmap="v1.1.2"
github.com/bep/godartsass="v0.12.0"
github.com/bep/gowebp="v0.1.0"
github.com/bep/tmc="v0.5.1"
github.com/cli/safeexec="v1.0.0"
github.com/cpuguy83/go-md2man/v2="v2.0.0"
github.com/danwakefield/fnmatch="v0.0.0-20160403171240-cbb64ac3d964"
github.com/disintegration/gift="v1.2.1"
github.com/dlclark/regexp2="v1.4.0"
github.com/dustin/go-humanize="v1.0.0"
github.com/evanw/esbuild="v0.11.16"
github.com/fsnotify/fsnotify="v1.4.9"
github.com/getkin/kin-openapi="v0.61.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.2.2"
github.com/gobwas/glob="v0.2.3"
github.com/gohugoio/go-i18n/v2="v2.1.3-0.20210430103248-4c28c89f8013"
github.com/golang/groupcache="v0.0.0-20200121045136-8c9f03a8e57e"
github.com/golang/protobuf="v1.5.2"
github.com/google/go-cmp="v0.5.5"
github.com/google/uuid="v1.1.2"
github.com/google/wire="v0.4.0"
github.com/googleapis/gax-go/v2="v2.0.5"
github.com/googleapis/gax-go="v2.0.2+incompatible"
github.com/gorilla/websocket="v1.4.2"
github.com/hashicorp/hcl="v1.0.0"
github.com/jdkato/prose="v1.2.1"
github.com/jmespath/go-jmespath="v0.4.0"
github.com/kyokomi/emoji/v2="v2.2.8"
github.com/magiconair/properties="v1.8.1"
github.com/mailru/easyjson="v0.0.0-20190626092158-b2ccc519800e"
github.com/mattn/go-ieproxy="v0.0.1"
github.com/mattn/go-isatty="v0.0.12"
github.com/mattn/go-runewidth="v0.0.9"
github.com/miekg/mmark="v1.3.6"
github.com/mitchellh/hashstructure="v1.0.0"
github.com/mitchellh/mapstructure="v1.3.3"
github.com/muesli/smartcrop="v0.3.0"
github.com/niklasfasching/go-org="v1.5.0"
github.com/olekukonko/tablewriter="v0.0.5"
github.com/pelletier/go-toml="v1.9.0"
github.com/pkg/errors="v0.9.1"
github.com/rogpeppe/go-internal="v1.8.0"
github.com/russross/blackfriday/v2="v2.0.1"
github.com/russross/blackfriday="v1.5.3-0.20200218234912-41c5fccfd6f6"
github.com/rwcarlsen/goexif="v0.0.0-20190401172101-9e8deecbddbd"
github.com/sanity-io/litter="v1.5.0"
github.com/shurcooL/sanitized_anchor_name="v1.0.0"
github.com/spf13/afero="v1.6.0"
github.com/spf13/cast="v1.3.1"
github.com/spf13/cobra="v1.1.3"
github.com/spf13/fsync="v0.9.0"
github.com/spf13/jwalterweatherman="v1.1.0"
github.com/spf13/pflag="v1.0.5"
github.com/spf13/viper="v1.7.1"
github.com/subosito/gotenv="v1.2.0"
github.com/tdewolff/minify/v2="v2.9.16"
github.com/tdewolff/parse/v2="v2.5.14"
github.com/yuin/goldmark-highlighting="v0.0.0-20200307114337-60d527fdb691"
github.com/yuin/goldmark="v1.3.5"
go.opencensus.io="v0.23.0"
gocloud.dev="v0.20.0"
golang.org/x/image="v0.0.0-20210220032944-ac19c3e999fb"
golang.org/x/net="v0.0.0-20210316092652-d523dce5a7f4"
golang.org/x/oauth2="v0.0.0-20210413134643-5e61552d6c78"
golang.org/x/sync="v0.0.0-20210220032951-036812b2e83c"
golang.org/x/sys="v0.0.0-20210412220455-f1c623a9e750"
golang.org/x/text="v0.3.6"
golang.org/x/xerrors="v0.0.0-20200804184101-5ec99f83aff1"
google.golang.org/api="v0.45.0"
google.golang.org/genproto="v0.0.0-20210413151531-c14fb6ef47c3"
google.golang.org/grpc="v1.37.0"
google.golang.org/protobuf="v1.26.0"
gopkg.in/ini.v1="v1.51.1"
gopkg.in/yaml.v2="v2.4.0"