README

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"


Documentation

The Go Gopher

There is no documentation for this package.

Source Files

Directories

Path Synopsis
Package bufferpool provides a pool of bytes buffers.
Package bufferpool provides a pool of bytes buffers.
cache
namedmemcache
Package namedmemcache provides a memory cache with a named lock.
Package namedmemcache provides a memory cache with a named lock.
Package codegen contains helpers for code generation.
Package codegen contains helpers for code generation.
Package commands defines and implements command-line commands and flags used by Hugo.
Package commands defines and implements command-line commands and flags used by Hugo.
common
collections
Package collections contains common Hugo functionality related to collection handling.
Package collections contains common Hugo functionality related to collection handling.
herrors
Package herrors contains common Hugo errors and error related utilities.
Package herrors contains common Hugo errors and error related utilities.
hreflect
Package hreflect contains reflect helpers.
Package hreflect contains reflect helpers.
para
Package para implements parallel execution helpers.
Package para implements parallel execution helpers.
terminal
Package terminal contains helper for the terminal, such as coloring output.
Package terminal contains helper for the terminal, such as coloring output.
types
Package types contains types shared between packages in Hugo.
Package types contains types shared between packages in Hugo.
Package create provides functions to create new content.
Package create provides functions to create new content.
Package docshelper provides some helpers for the Hugo documentation, and is of limited interest for the general Hugo user.
Package docshelper provides some helpers for the Hugo documentation, and is of limited interest for the general Hugo user.
Package helpers implements general utility functions that work with and on content.
Package helpers implements general utility functions that work with and on content.
hqt
Package hugofs provides the file systems used by Hugo.
Package hugofs provides the file systems used by Hugo.
filesystems
Package filesystems provides the fine grained file systems used by Hugo.
Package filesystems provides the fine grained file systems used by Hugo.
asciidocext
Package asciidocext converts AsciiDoc to HTML using Asciidoctor external binary.
Package asciidocext converts AsciiDoc to HTML using Asciidoctor external binary.
asciidocext/asciidocext_config
Package asciidoc_config holds asciidoc related configuration.
Package asciidoc_config holds asciidoc related configuration.
blackfriday
Package blackfriday converts Markdown to HTML using Blackfriday v1.
Package blackfriday converts Markdown to HTML using Blackfriday v1.
goldmark
Package goldmark converts Markdown to HTML using Goldmark.
Package goldmark converts Markdown to HTML using Goldmark.
goldmark/goldmark_config
Package goldmark_config holds Goldmark related configuration.
Package goldmark_config holds Goldmark related configuration.
highlight
Package highlight provides code highlighting.
Package highlight provides code highlighting.
mmark
Package mmark converts Markdown to HTML using MMark v1.
Package mmark converts Markdown to HTML using MMark v1.
org
Package org converts Emacs Org-Mode to HTML.
Package org converts Emacs Org-Mode to HTML.
pandoc
Package pandoc converts content to HTML using Pandoc as an external helper.
Package pandoc converts content to HTML using Pandoc as an external helper.
rst
Package rst converts content to HTML using the RST external helper.
Package rst converts content to HTML using the RST external helper.
Package metrics provides simple metrics tracking features.
Package metrics provides simple metrics tracking features.
Package minifiers contains minifiers mapped to MIME types.
Package minifiers contains minifiers mapped to MIME types.
mods module
Package modules provides a client that can be used to manage Hugo Components, what's referred to as Hugo Modules.
Package modules provides a client that can be used to manage Hugo Components, what's referred to as Hugo Modules.
npm
pageparser
Package pageparser provides a parser for Hugo content files (Markdown, HTML etc.) in Hugo.
Package pageparser provides a parser for Hugo content files (Markdown, HTML etc.) in Hugo.
Package related holds code to help finding related content.
Package related holds code to help finding related content.
Package releaser implements a set of utilities and a wrapper around Goreleaser to help automate the Hugo release process.
Package releaser implements a set of utilities and a wrapper around Goreleaser to help automate the Hugo release process.
images
Package images provides template functions for manipulating images.
Package images provides template functions for manipulating images.
page
Package page contains the core interfaces and types for the Page resource, a core component in Hugo.
Package page contains the core interfaces and types for the Page resource, a core component in Hugo.
resource_factories/bundler
Package bundler contains functions for concatenation etc.
Package bundler contains functions for concatenation etc.
resource_factories/create
Package create contains functions for to create Resource objects.
Package create contains functions for to create Resource objects.
resource_transformers/templates
Package templates contains functions for template processing of Resource objects.
Package templates contains functions for template processing of Resource objects.
resource_transformers/tocss/dartsass
Package godartsass integrates with the Dass Sass Embedded protocol to transpile SCSS/SASS.
Package godartsass integrates with the Dass Sass Embedded protocol to transpile SCSS/SASS.
scripts
tpl
cast
Package cast provides template functions for data type conversions.
Package cast provides template functions for data type conversions.
collections
Package collections provides template functions for manipulating collections such as arrays, maps, and slices.
Package collections provides template functions for manipulating collections such as arrays, maps, and slices.
compare
Package compare provides template functions for comparing values.
Package compare provides template functions for comparing values.
crypto
Package crypto provides template functions for cryptographic operations.
Package crypto provides template functions for cryptographic operations.
data
Package data provides template functions for working with external data sources.
Package data provides template functions for working with external data sources.
debug
Package debug provides template functions to help debugging templates.
Package debug provides template functions to help debugging templates.
encoding
Package encoding provides template functions for encoding content.
Package encoding provides template functions for encoding content.
fmt
Package fmt provides template functions for formatting strings.
Package fmt provides template functions for formatting strings.
hugo
Package hugo provides template functions for accessing the Site Hugo object.
Package hugo provides template functions for accessing the Site Hugo object.
images
Package images provides template functions for manipulating images.
Package images provides template functions for manipulating images.
inflect
Package inflect provides template functions for the inflection of words.
Package inflect provides template functions for the inflection of words.
js
Package js provides functions for building JavaScript resources
Package js provides functions for building JavaScript resources
lang
Package lang provides template functions for content internationalization.
Package lang provides template functions for content internationalization.
math
Package math provides template functions for mathematical operations.
Package math provides template functions for mathematical operations.
os
Package os provides template functions for interacting with the operating system.
Package os provides template functions for interacting with the operating system.
partials
Package partials provides template functions for working with reusable templates.
Package partials provides template functions for working with reusable templates.
path
Package path provides template functions for manipulating paths.
Package path provides template functions for manipulating paths.
reflect
Package reflect provides template functions for run-time object reflection.
Package reflect provides template functions for run-time object reflection.
resources
Package resources provides template functions for working with resources.
Package resources provides template functions for working with resources.
safe
Package safe provides template functions for escaping untrusted content or encapsulating trusted content.
Package safe provides template functions for escaping untrusted content or encapsulating trusted content.
site
Package site provides template functions for accessing the Site object.
Package site provides template functions for accessing the Site object.
strings
Package strings provides template functions for manipulating strings.
Package strings provides template functions for manipulating strings.
templates
Package templates provides template functions for working with templates.
Package templates provides template functions for working with templates.
time
Package time provides template functions for measuring and displaying time.
Package time provides template functions for measuring and displaying time.
tplimpl/embedded
Package embedded defines the internal templates that Hugo provides.
Package embedded defines the internal templates that Hugo provides.
transform
Package transform provides template functions for transforming content.
Package transform provides template functions for transforming content.
urls
Package urls provides template functions to deal with URLs.
Package urls provides template functions to deal with URLs.