The world’s fastest framework for building websites.
Permalink
Failed to load latest commit information.
.circleci Release 0.48 Aug 28, 2018
.github Create SUPPORT.md May 21, 2018
bufferpool bufpool: Add package doc Apr 9, 2016
cache Simplify .Site.GetPage etc. Jul 17, 2018
commands commands: Remove deprecated flags Sep 21, 2018
common tpl/collections: Add collections.Append Sep 14, 2018
compare Make ge, le etc. work with the Hugo Version number Feb 22, 2018
config config: Fix golint issues Sep 7, 2018
create Add Hugo Piper with SCSS support and much more Jul 6, 2018
deps deps: Fix most golint issues Sep 7, 2018
docs docs: Add docs for append Sep 14, 2018
docshelper Add some missing doc comments Aug 3, 2017
examples examples: Fix `now` usage in footer Sep 27, 2017
helpers helpers: Fix golint issues Sep 7, 2018
hugofs hugofs: Fix filepath issue in test Sep 7, 2018
hugolib hugolib: Remove deprecated rssURI Sep 21, 2018
i18n i18n: Fix golint issue Sep 7, 2018
langs langs: Fix golint godoc issue Sep 7, 2018
livereload livereload: Fix host comparison when ports aren't present Dec 16, 2017
media media: Fix golint issues Sep 7, 2018
metrics metrics: Reset benchmark timer Oct 7, 2017
minifiers minifiers: Set minifier to KeepEndTags Sep 13, 2018
output Improve some godoc comments Sep 7, 2018
parser Add Hugo Piper with SCSS support and much more Jul 6, 2018
publisher publisher: Fix golint godoc issue Sep 7, 2018
related related: Fix golint issues Sep 7, 2018
releaser Update releasenotes_writer.go Sep 14, 2018
resource tpl/collections: Add collections.Append Sep 14, 2018
source Improve some godoc comments Sep 7, 2018
tpl tpl/opengraph: Use safeHTMLAttr instead of safeHTML for HTML attributes Sep 21, 2018
transform Add support for minification of final output Aug 6, 2018
watcher Add some missing doc comments Aug 3, 2017
.dockerignore Update Dockerfile to a multi-stage build Jun 14, 2018
.gitattributes .gitattributes: Exclude *.svg from CRLF/LF conversion Jul 10, 2018
.gitignore Add Hugo Piper with SCSS support and much more Jul 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 Fix broken Travis config Sep 6, 2018
CONTRIBUTING.md Update CONTRIBUTING.md Aug 29, 2018
Dockerfile Update Dockerfile to Go 1.11 Aug 31, 2018
LICENSE Add a GitHub compatible Apache 2 license text Apr 15, 2018
README.md Update README.md Aug 29, 2018
appveyor.yml Update to latest Mage Sep 3, 2018
bench.sh Add GOEXE to support building with different versions of `go` Jul 15, 2017
benchSite.sh Run benchmarks 3 times Jan 13, 2018
bepdock.sh Add temporary build script Jul 8, 2018
go.mod Update Mage Sep 12, 2018
go.sum tpl/collections: Add collections.Append Sep 14, 2018
goreleaser-extended.yml releaser: Fix goreleaser config Aug 15, 2018
goreleaser.yml Fix build on armv7 Aug 20, 2018
magefile.go Fix error message for go vet Aug 30, 2018
main.go commands: Make commands.Execute return a Response object Apr 11, 2018
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
snapcraft.yaml snapcraft: Update to work with Go Modules Aug 29, 2018

README.md

Hugo

A Fast and Flexible Static Site Generator built with love by bep, spf13 and friends in Go.

Website | Forum | Developer Chat (no support) | Documentation | Installation Guide | Contribution Guide | Twitter

GoDoc Linux and macOS Build Status Windows Build Status Dev chat at https://gitter.im/gohugoio/hugo 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 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