You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Bjørn Erik Pedersen 7aaaf7e33a
mod: Remove superflous replace statement
14 hours ago
.circleci releaser: Bump to Goreleaser v0.171.0 1 month ago
.github github: Set a dummy Instagram token 2 months ago
bufferpool tests: Convert from testify to quicktest 2 years ago
cache Misc config loading fixes 2 months ago
codegen all: Fix minor typos 8 months ago
commands Switch to go-toml v2 6 days ago
common Reduce binary size vs locale, update to CLDR v36.1 15 hours ago
compare all: Format code with gofumpt 8 months ago
config config: Fix a potential deadlock in config reading 4 days ago
create hugofs: Make FileMeta a struct 3 weeks ago
deploy Misc config loading fixes 2 months ago
deps tpl/fmt: Add erroridf template func 2 months ago
docs Merge branch 'release-0.86.1' 4 days ago
docshelper Some minify configuration adjustments 1 year ago
examples examples: Remove unneeded meta tag from blog example 8 months ago
helpers Bump all long-living deprecations to ERRORs 1 week ago
htesting Add Dart Sass support 7 months ago
hugofs hugofs: Make FileMeta a struct 3 weeks ago
hugolib Reduce binary size vs locale, update to CLDR v36.1 15 hours ago
identity all: Format code with gofumpt 8 months ago
langs Reduce binary size vs locale, update to CLDR v36.1 15 hours ago
lazy all: Format code with gofumpt 8 months ago
livereload all: Format code with gofumpt 8 months ago
markup markup: Add tabindex="0" to default <pre> wrapper 3 weeks ago
media media: Adjust test assertion 2 months ago
metrics all: Format code with gofumpt 8 months ago
minifiers minifiers: Make keepWhitespace = true default for HTML 2 weeks ago
modules hugofs: Make FileMeta a struct 3 weeks ago
navigation Improve handling of <nil> Params 4 days ago
output output: Make WebAppManifestFormat NotAlternative=true 2 months ago
parser Switch to go-toml v2 6 days ago
publisher Misc config loading fixes 2 months ago
related Misc config loading fixes 2 months ago
releaser Fix theme count in release notes 2 weeks ago
resources Go back to WARNING for Page deprecations 5 days ago
scripts/fork_go_templates Pull in latest Go 1.16 template source 6 months ago
snap releaser: Prepare repository for 0.87.0-DEV 4 days ago
source hugofs: Make FileMeta a struct 3 weeks ago
temp releaser: Add release notes for 0.86.1 4 days ago
tpl Reduce binary size vs locale, update to CLDR v36.1 15 hours ago
transform all: Fix minor typos 8 months ago
watcher Add polling as a fallback to native filesystem events in server watch 4 weeks ago
.dockerignore Support Docker args TAGS, WORKDIR, CGO; speed up repetitive builds 2 years ago
.gitattributes .gitattributes: Exclude *.svg from CRLF/LF conversion 3 years ago
.gitignore Collect HTML elements during the build to use in PurgeCSS etc. 1 year ago
.gitmodules Remove the theme submodule from /docs 4 years ago
.mailmap Add .mailmap to get a more correct author log 7 years ago
CONTRIBUTING.md Update CONTRIBUTING.md 5 months ago
Dockerfile #8210 Upgrade golang version for Dockerfile 5 months ago
LICENSE Add a GitHub compatible Apache 2 license text 3 years ago
README.md readme: Update dependency list 3 months ago
SECURITY.md Update SECURITY.md 7 months ago
bench.sh Add GOEXE to support building with different versions of `go` 4 years ago
benchSite.sh all: Fix minor typos 8 months ago
benchbep.sh Add Hugo Modules 2 years ago
bepdock.sh build: Update the temp docker script 3 years ago
go.mod mod: Remove superflous replace statement 14 hours ago
go.sum Reduce binary size vs locale, update to CLDR v36.1 15 hours ago
goreleaser.yml Use SPDX license identifier 2 months ago
magefile.go all: Format code with gofumpt 8 months ago
main.go all: Format code with gofumpt 8 months ago
merge-release.sh Add merge helper 10 months ago
pull-docs.sh Allow the pull-docs script to pull other than master 4 years ago

README.md

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 don’t 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"