A Fast and Flexible Static Site Generator built with love in GoLang
Go Other
Permalink
Failed to load latest commit information.
bufferpool bufpool: Add package doc Apr 9, 2016
commands commands: Fix newly broken server flag handling Jan 11, 2017
create all: Refactor to non-global logger Jan 7, 2017
docs docs: Update author credits in GH pages tutorial Jan 15, 2017
examples Update documentation and test for sitemap template Jan 3, 2017
helpers helpers: Allow tilde in URLs Jan 7, 2017
hugofs all: Unify case of config variable names Oct 24, 2016
hugolib all: Refactor to nonglobal template handling Jan 10, 2017
livereload livereload: Simplify RefreshPath Dec 28, 2016
parser commands, hugolib, parser, tpl: Use errors.New instead of fmt.Errorf Nov 22, 2016
source docs, tpl: Fix documentation of UniqueID Dec 31, 2016
target target: Add COM0 and LPT0 as reservedNames on Windows Jan 6, 2017
tpl tpl: Fix broken benchmarks Jan 14, 2017
transform transform: Simplify Nov 23, 2016
utils utils: Add godoc Mar 22, 2016
vendor all: Refactor to nonglobal template handling Jan 10, 2017
watcher Update import path of fsnotify Apr 20, 2016
.gitignore Add GoBuilds to .gitignore Dec 19, 2016
.goxc.json add more architectures to .goxc Dec 8, 2015
.mailmap Add .mailmap to get a more correct author log Jan 28, 2015
.travis.yml Clean up Makefile (#2924) Jan 11, 2017
CONTRIBUTING.md Enhance commit message guidelines Nov 4, 2016
Dockerfile Fix Dockerfile Dec 28, 2016
LICENSE.md Change the license to Apache 2.0 Nov 24, 2015
Makefile Clean up Makefile (#2924) Jan 11, 2017
README.md Remove waffle.io graph from README Jan 2, 2017
appveyor.yml Clean up Makefile (#2924) Jan 11, 2017
bench.sh Add benchmark for sort and reverse Jul 21, 2015
main.go Exit with error code on any error Mar 11, 2016
requirements.txt Bump Pygment version to 2.1.3 Mar 13, 2016
snapcraft.yaml Bump to 0.19-DEV Dec 19, 2016

README.md

Hugo

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

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

GoDoc Linux and OS X Build Status Windows Build Status Dev chat at https://gitter.im/spf13/hugo Go Report Card

Overview

Hugo is a static HTML and CSS website generator written in Go. It is optimized for speed, easy 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 meta data. 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 and OS X (Darwin) 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)

Add Hugo and its package dependencies to your go src directory.

go get -v github.com/spf13/hugo

Once the get completes, you should find your new hugo (or hugo.exe) executable sitting inside $GOPATH/bin/.

To update Hugo’s dependencies, use go get with the -u option.

go get -u -v github.com/spf13/hugo

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