The world’s fastest framework for building websites.
Find a file
Cameron Moore ccd3285484 releaser: Fix golint issues
struct field HtmlURL should be HTMLURL
2018-09-07 08:25:51 +02:00
.circleci Release 0.48 2018-08-28 23:17:01 +02:00
.github Create SUPPORT.md 2018-05-21 16:56:30 +02:00
bufferpool bufpool: Add package doc 2016-04-10 01:34:15 +02:00
cache Simplify .Site.GetPage etc. 2018-07-18 00:07:20 +02:00
commands commands: Fix golint issues 2018-09-07 08:25:51 +02:00
common common: Fix golint errors 2018-09-07 08:25:51 +02:00
compare Make ge, le etc. work with the Hugo Version number 2018-02-22 09:15:12 +01:00
config config: Fix golint issues 2018-09-07 08:25:51 +02:00
create Add Hugo Piper with SCSS support and much more 2018-07-06 11:46:12 +02:00
deps deps: Fix most golint issues 2018-09-07 08:25:51 +02:00
docs hugolib: Do not FirstUpper taxonomy titles 2018-09-06 20:29:21 +02:00
docshelper Add some missing doc comments 2017-08-03 15:57:51 +02:00
examples examples: Fix now usage in footer 2017-09-27 08:42:44 +02:00
helpers helpers: Fix golint issues 2018-09-07 08:25:51 +02:00
hugofs hugofs: Fix golint issues 2018-09-07 08:25:51 +02:00
hugolib hugolib: Do not FirstUpper taxonomy titles 2018-09-06 20:29:21 +02:00
i18n Add Hugo Piper with SCSS support and much more 2018-07-06 11:46:12 +02:00
langs Make resources fetched via resources.Get and similar language agnostic 2018-07-31 23:33:04 +02:00
livereload livereload: Fix host comparison when ports aren't present 2017-12-16 19:06:00 +01:00
media Improve minifier MIME type resolution 2018-08-28 17:00:53 +02:00
metrics metrics: Reset benchmark timer 2017-10-07 20:41:25 +02:00
minifiers Improve minifier MIME type resolution 2018-08-28 17:00:53 +02:00
output Improve minifier MIME type resolution 2018-08-28 17:00:53 +02:00
parser Add Hugo Piper with SCSS support and much more 2018-07-06 11:46:12 +02:00
publisher publisher: Close file when done 2018-08-11 20:19:07 +02:00
related Clean up lint in various packages 2017-09-29 16:23:16 +02:00
releaser releaser: Fix golint issues 2018-09-07 08:25:51 +02:00
resource common: Fix golint errors 2018-09-07 08:25:51 +02:00
source source: Fix golint godoc issues 2018-09-07 08:25:51 +02:00
tpl tpl/tplimpl: Make the autogenerated templates collapsed in PRs 2018-08-23 22:03:43 +02:00
transform Add support for minification of final output 2018-08-06 19:58:41 +02:00
watcher Add some missing doc comments 2017-08-03 15:57:51 +02:00
.dockerignore Update Dockerfile to a multi-stage build 2018-06-14 15:47:04 -06:00
.gitattributes .gitattributes: Exclude *.svg from CRLF/LF conversion 2018-07-09 21:06:15 -06:00
.gitignore Add Hugo Piper with SCSS support and much more 2018-07-06 11:46:12 +02:00
.gitmodules Remove the theme submodule from /docs 2017-08-10 14:54:19 +02:00
.mailmap Add .mailmap to get a more correct author log 2015-01-28 16:50:36 +01:00
.travis.yml Fix broken Travis config 2018-09-06 13:42:41 +02:00
appveyor.yml Update to latest Mage 2018-09-03 10:18:59 +02:00
bench.sh Add GOEXE to support building with different versions of go 2017-07-16 00:35:15 +02:00
benchSite.sh Run benchmarks 3 times 2018-01-14 00:49:01 +01:00
bepdock.sh Add temporary build script 2018-07-08 16:08:22 +02:00
CONTRIBUTING.md Update CONTRIBUTING.md 2018-08-29 14:21:20 +02:00
Dockerfile Update Dockerfile to Go 1.11 2018-08-31 09:05:52 +02:00
go.mod Update to latest Mage 2018-09-03 10:18:59 +02:00
go.sum Fix broken Travis config 2018-09-06 13:42:41 +02:00
goreleaser-extended.yml releaser: Fix goreleaser config 2018-08-15 09:31:56 +02:00
goreleaser.yml Fix build on armv7 2018-08-20 19:44:00 +02:00
LICENSE Add a GitHub compatible Apache 2 license text 2018-04-16 00:03:30 +02:00
magefile.go Fix error message for go vet 2018-08-30 22:30:49 +02:00
main.go commands: Make commands.Execute return a Response object 2018-04-11 20:37:08 +02:00
pull-docs.sh Allow the pull-docs script to pull other than master 2017-09-23 10:13:40 +02:00
README.md Update README.md 2018-08-29 14:17:47 +02:00
requirements.txt travis: Pull docutils out into requirements.txt 2017-08-11 18:39:04 +02:00
snapcraft.yaml snapcraft: Update to work with Go Modules 2018-08-29 09:37:26 +02:00

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 dont 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