The world’s fastest framework for building websites.
Find a file
2018-10-24 20:33:07 +02:00
.circleci
.github
bufferpool
cache
commands commands: Read disableFastRender from flag even if it's not changed 2018-10-24 20:33:07 +02:00
common common/loggers: Remove the ANSI color for the browser error version 2018-10-24 17:22:07 +02:00
compare
config
create commands: Show server error info in browser 2018-10-16 22:10:56 +02:00
deps hugolib: Continue the file context/line number errors work 2018-10-22 20:46:14 +02:00
docs tpl: Update Jsonify to return pretty-print output 2018-10-21 23:36:35 +02:00
docshelper
examples
helpers commands: Show server error info in browser 2018-10-16 22:10:56 +02:00
hugofs Resolve error handling/parser related TODOs 2018-10-23 19:41:22 +02:00
hugolib hugolib: Adjust error test to make it pass on Go tip 2018-10-24 15:19:49 +02:00
i18n hugolib: Improve errors in /i18n handlling 2018-10-22 20:46:14 +02:00
langs
livereload
media
metrics
minifiers
output
parser Resolve error handling/parser related TODOs 2018-10-23 19:41:22 +02:00
publisher
related
releaser commands: Show server error info in browser 2018-10-16 22:10:56 +02:00
resource commands: Show server error info in browser 2018-10-16 22:10:56 +02:00
snap snap: Set "extended" tag based on build_url on Launchpad 2018-10-12 11:10:38 +08:00
source Allow date and slug from filename for leaf bundles 2018-10-16 23:51:48 +02:00
tpl tpl: Handle truncated identifiers in Go template errors 2018-10-24 13:54:04 +02:00
transform
watcher
.dockerignore
.gitattributes
.gitignore Add GOPATH Hugo building tip 2018-10-09 11:09:00 +02:00
.gitmodules
.mailmap
.travis.yml
appveyor.yml
bench.sh
benchSite.sh
bepdock.sh build: Update the temp docker script 2018-09-24 12:41:12 +02:00
CONTRIBUTING.md Simple doc fix in CONTRIBUTING.md 2018-10-16 13:30:00 +02:00
Dockerfile
go.mod Add some color to the relevant filenames in terminal log 2018-10-24 13:02:18 +02:00
go.sum herrors: Improve handling of JSON errors 2018-10-23 14:35:43 +02:00
goreleaser-extended.yml
goreleaser.yml
LICENSE
magefile.go
main.go
pull-docs.sh
README.md Update URLs to stop 301 redirects 2018-10-11 22:44:06 +02:00
requirements.txt

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/spf13/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 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