You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Fazal Majid c0d7188ec8 deploy: Do not compile in Azure on Solaris 4 days ago
.circleci Update to Go 1.13 1 week ago
.github Create SUPPORT.md 1 year ago
bufferpool tests: Convert from testify to quicktest 1 month ago
cache filecache: Ignore "does not exist" errors in prune 4 days ago
codegen tests: Convert from testify to quicktest 1 month ago
commands commands: Make sure the hugo field is always initialized before it's used 1 month ago
common releaser: Prepare repository for 0.59.0-DEV 4 days ago
compare tests: Convert from testify to quicktest 1 month ago
config tests: Convert from testify to quicktest 1 month ago
create tests: Convert from testify to quicktest 1 month ago
deploy deploy: Do not compile in Azure on Solaris 4 days ago
deps Block symlink dir traversal for /static 1 month ago
docs releaser: Add release notes to /docs for release of 0.58.2 4 days ago
docshelper Add some missing doc comments 2 years ago
examples examples: Fix multilingual example compatibility with latest version 1 month ago
helpers tests: Convert from testify to quicktest 1 month ago
htesting Image resource refactor 3 weeks ago
hugofs Improve the server assets cache invalidation logic 1 month ago
hugolib Fix cache keys for bundled resoures in transform.Unmarshal 4 days ago
langs tests: Convert from testify to quicktest 1 month ago
lazy tests: Convert from testify to quicktest 1 month ago
livereload Fix livereload for @import case 1 month ago
media tests: Convert from testify to quicktest 1 month ago
metrics tests: Convert from testify to quicktest 1 month ago
minifiers tests: Convert from testify to quicktest 1 month ago
modules Make the "is this a Hugo Module" logic more lenient 1 week ago
navigation Merge pull request #6149 from bep/sort-caseinsensitive 1 month ago
output tests: Convert from testify to quicktest 1 month ago
parser tests: Convert from testify to quicktest 1 month ago
publisher Make Page an interface 5 months ago
related tests: Convert from testify to quicktest 1 month ago
releaser tests: Convert from testify to quicktest 1 month ago
resources Fix cache keys for bundled resoures in transform.Unmarshal 4 days ago
snap releaser: Prepare repository for 0.59.0-DEV 4 days ago
source source: Remove debug check left during development 3 weeks ago
tpl tpl: Remove eq argument limitation 1 week ago
transform tests: Convert from testify to quicktest 1 month ago
watcher Add some missing doc comments 2 years ago
.dockerignore Support Docker args TAGS, WORKDIR, CGO; speed up repetitive builds 6 months ago
.gitattributes .gitattributes: Exclude *.svg from CRLF/LF conversion 1 year ago
.gitignore resources: Fix test on Windows 1 month ago
.gitmodules Remove the theme submodule from /docs 2 years ago
.mailmap Add .mailmap to get a more correct author log 4 years ago
.travis.yml Update to Go 1.13 1 week ago
CONTRIBUTING.md Remove appveyor 10 months ago
Dockerfile dockerfile: Switch base image for final build 3 months ago
LICENSE Add a GitHub compatible Apache 2 license text 1 year ago
README.md Use the SVG logo in README.md 1 month ago
bench.sh Add GOEXE to support building with different versions of `go` 2 years ago
benchSite.sh Run benchmarks 3 times 1 year ago
benchbep.sh Add Hugo Modules 1 month ago
bepdock.sh build: Update the temp docker script 11 months ago
go.mod deps: Update github.com/bep/gitmap 1 week ago
go.sum deps: Update github.com/bep/gitmap 1 week ago
goreleaser.yml releaser: Update Go Releaser and consolidate the 2 configs 3 months ago
magefile.go tests: Convert from testify to quicktest 1 month ago
main.go Add HUGO_NUMWORKERMULTIPLIER 5 months ago
pull-docs.sh Allow the pull-docs script to pull other than master 2 years ago
requirements.txt travis: Pull docutils out into requirements.txt 2 years ago

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 |