Skip to content
The world’s fastest framework for building websites.
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci releaser: Update Go Releaser and consolidate the 2 configs Jun 10, 2019
.github Create SUPPORT.md May 21, 2018
bufferpool bufpool: Add package doc Apr 9, 2016
cache all: Apply staticcheck recommendations Mar 24, 2019
codegen Avoid nilpointer on no File on Page Mar 26, 2019
commands deploy: Default --target to the first deployment target Jun 7, 2019
common releaser: Prepare repository for 0.56.0-DEV May 18, 2019
compare tpl: Allow the partial template func to return any type Apr 2, 2019
config Add HUGO_NUMWORKERMULTIPLIER Apr 5, 2019
create all: Apply staticcheck recommendations Mar 24, 2019
deploy deploy: Default --target to the first deployment target Jun 7, 2019
deps Avoid nilpointer on no File on Page Mar 26, 2019
docs Improve Org mode support: Replace goorgeous with go-org Jun 8, 2019
docshelper Add some missing doc comments Aug 3, 2017
examples examples: Update link to prevent redirect Jun 12, 2019
helpers Improve Org mode support: Replace goorgeous with go-org Jun 8, 2019
htesting Make Page an interface Mar 23, 2019
hugofs all: Apply staticcheck recommendations Mar 24, 2019
hugolib tpl/collections: Fix slice type handling in sort Jun 10, 2019
langs i18n: Move the package below /langs May 4, 2019
lazy lazy: Fix concurrent initialization order May 1, 2019
livereload livereload: Fix host comparison when ports aren't present Dec 16, 2017
media Make Page an interface Mar 23, 2019
metrics metrics: Adjust the howSimilar logic vs strings Apr 2, 2019
minifiers all: Apply staticcheck recommendations Mar 24, 2019
navigation Fix menu URL when multiple permalinkable output formats Apr 19, 2019
output output: Fix permalink in sitemap etc. when multiple permalinkable out… May 2, 2019
parser Refactor Org mode front matter: Introduce '#+KEY[]:' array notation Jun 8, 2019
publisher Make Page an interface Mar 23, 2019
related Make Page an interface Mar 23, 2019
releaser releaser: Remove version replacement in docs config Apr 1, 2019
resources tpl/collections: Fix slice type handling in sort Jun 10, 2019
snap releaser: Prepare repository for 0.56.0-DEV May 18, 2019
source Avoid nilpointer on no File on Page Mar 26, 2019
tpl tpl/collections: Fix slice type handling in sort Jun 10, 2019
transform all: Apply staticcheck recommendations Mar 24, 2019
watcher Add some missing doc comments Aug 3, 2017
.dockerignore Support Docker args TAGS, WORKDIR, CGO; speed up repetitive builds Feb 22, 2019
.gitattributes .gitattributes: Exclude *.svg from CRLF/LF conversion Jul 10, 2018
.gitignore Add tpl/site and tpl/hugo Dec 6, 2018
.gitmodules Squashed 'docs/' content from commit f887bd7b Aug 10, 2017
.mailmap Add .mailmap to get a more correct author log Jan 28, 2015
.travis.yml Update to Go 1.12.5 and Go 1.11.10 May 15, 2019
CONTRIBUTING.md Remove appveyor Nov 13, 2018
Dockerfile dockerfile: Switch base image for final build May 23, 2019
LICENSE Add a GitHub compatible Apache 2 license text Apr 15, 2018
README.md Improve Org mode support: Replace goorgeous with go-org Jun 8, 2019
bench.sh Add GOEXE to support building with different versions of `go` Jul 15, 2017
benchSite.sh Run benchmarks 3 times Jan 13, 2018
benchbep.sh Use YAML for the benchmark compare Apr 5, 2019
bepdock.sh build: Update the temp docker script Sep 24, 2018
go.mod deps: Revert to an older version of Blackfriday Jun 16, 2019
go.sum deps: Revert to an older version of Blackfriday Jun 16, 2019
goreleaser.yml releaser: Update Go Releaser and consolidate the 2 configs Jun 10, 2019
magefile.go Avoid nilpointer on no File on Page Mar 26, 2019
main.go Add HUGO_NUMWORKERMULTIPLIER Apr 5, 2019
pull-docs.sh Allow the pull-docs script to pull other than master Sep 23, 2017
requirements.txt travis: Pull docutils out into requirements.txt Aug 11, 2017

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 Linux and macOS Build Status 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, 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 DragonFly BSD, OpenBSD, 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%.

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.

Because 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, in lexical order:

Dependency License
github.com/BurntSushi/locker The Unlicense
github.com/BurntSushi/toml MIT License
github.com/PuerkitoBio/purell BSD 3-Clause "New" or "Revised" License
github.com/PuerkitoBio/urlesc BSD 3-Clause "New" or "Revised" License
github.com/alecthomas/chroma MIT License
github.com/bep/debounce MIT License
github.com/bep/gitmap MIT License
github.com/bep/go-tocss MIT License
github.com/niklasfasching/go-org MIT License
github.com/cpuguy83/go-md2man MIT License
github.com/danwakefield/fnmatch BSD 2-Clause "Simplified" License
github.com/disintegration/imaging MIT License
github.com/dlclark/regexp2 MIT License
github.com/eknkc/amber MIT License
github.com/fsnotify/fsnotify BSD 3-Clause "New" or "Revised" License
github.com/gobwas/glob MIT License
github.com/gorilla/websocket BSD 2-Clause "Simplified" License
github.com/hashicorp/go-immutable-radix Mozilla Public License 2.0
github.com/hashicorp/golang-lru Mozilla Public License 2.0
github.com/hashicorp/hcl Mozilla Public License 2.0
github.com/jdkato/prose MIT License
github.com/kyokomi/emoji MIT License
github.com/magiconair/properties BSD 2-Clause "Simplified" License
github.com/markbates/inflect MIT License
github.com/mattn/go-isatty MIT License
github.com/mattn/go-runewidth MIT License
github.com/miekg/mmark Simplified BSD License
github.com/mitchellh/hashstructure MIT License
github.com/mitchellh/mapstructure MIT License
github.com/muesli/smartcrop MIT License
github.com/nicksnyder/go-i18n MIT License
github.com/olekukonko/tablewriter MIT License
github.com/pelletier/go-toml MIT License
github.com/pkg/errors BSD 2-Clause "Simplified" License
github.com/russross/blackfriday Simplified BSD License
github.com/shurcooL/sanitized_anchor_name MIT License
github.com/spf13/afero Apache License 2.0
github.com/spf13/cast MIT License
github.com/spf13/cobra Apache License 2.0
github.com/spf13/fsync MIT License
github.com/spf13/jwalterweatherman MIT License
github.com/spf13/nitro Apache License 2.0
github.com/spf13/pflag BSD 3-Clause "New" or "Revised" License
github.com/spf13/viper MIT License
github.com/tdewolff/minify MIT License
github.com/tdewolff/parse MIT License
github.com/wellington/go-libsass Apache License 2.0
github.com/yosssi/ace MIT License
golang.org/x/image BSD 3-Clause "New" or "Revised" License
golang.org/x/net BSD 3-Clause "New" or "Revised" License
golang.org/x/sync BSD 3-Clause "New" or "Revised" License
golang.org/x/sys BSD 3-Clause "New" or "Revised" License
golang.org/x/text BSD 3-Clause "New" or "Revised" License
gopkg.in/yaml.v2 Apache License 2.0
You can’t perform that action at this time.