The world’s fastest framework for building websites. https://gohugo.io
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.
 
 
 
Aleksandr Demakin ed3071b753
docs: Remove mention of a file size limit for readFile
1 day ago
.circleci Update to Go 1.15.1 and 1.14.8 4 months ago
.github Add Dart Sass support 3 weeks ago
bufferpool tests: Convert from testify to quicktest 1 year ago
cache all: Fix minor typos 1 month ago
codegen all: Fix minor typos 1 month ago
commands Add Dart Sass support 3 weeks ago
common releaser: Prepare repository for 0.81.0-DEV 3 weeks ago
compare all: Format code with gofumpt 1 month ago
config all: Fix minor typos 1 month ago
create Improve LookPath 1 month ago
deploy all: Format code with gofumpt 1 month ago
deps Add Dart Sass support 3 weeks ago
docs docs: Remove mention of a file size limit for readFile 1 day ago
docshelper Some minify configuration adjustments 10 months ago
examples examples: Remove unneeded meta tag from blog example 2 months ago
helpers Update emoji import paths and version 3 weeks ago
htesting Add Dart Sass support 3 weeks ago
hugofs build(deps): bump github.com/spf13/afero from 1.4.1 to 1.5.1 5 days ago
hugolib js: Add Inject config option 2 days ago
identity all: Format code with gofumpt 1 month ago
langs all: Fix minor typos 1 month ago
lazy all: Format code with gofumpt 1 month ago
livereload all: Format code with gofumpt 1 month ago
markup deps: Update go-org to v1.4.0 3 weeks ago
media all: Fix minor typos 1 month ago
metrics all: Format code with gofumpt 1 month ago
minifiers all: Fix minor typos 1 month ago
modules Add Dart Sass support 3 weeks ago
navigation all: Format code with gofumpt 1 month ago
output all: Format code with gofumpt 1 month ago
parser all: Fix minor typos 1 month ago
publisher all: Fix minor typos 1 month ago
related all: Format code with gofumpt 1 month ago
releaser Improve LookPath 1 month ago
resources js: Add Inject config option 2 days ago
scripts/fork_go_templates Improve LookPath 1 month ago
snap releaser: Prepare repository for 0.81.0-DEV 3 weeks ago
source all: Fix minor typos 1 month ago
tpl tpl/os: remove 1mb limit for readFile. 2 days ago
transform all: Fix minor typos 1 month ago
watcher watcher: Add file deleted by accident 2 months ago
.dockerignore Support Docker args TAGS, WORKDIR, CGO; speed up repetitive builds 1 year ago
.gitattributes .gitattributes: Exclude *.svg from CRLF/LF conversion 2 years ago
.gitignore Collect HTML elements during the build to use in PurgeCSS etc. 9 months ago
.gitmodules Remove the theme submodule from /docs 3 years ago
.mailmap Add .mailmap to get a more correct author log 6 years ago
CONTRIBUTING.md Fix a typo in CONTRIBUTING.md 5 months ago
Dockerfile build: Allow optional "nodeploy" tag to exclude deploy command from bin 3 months ago
LICENSE Add a GitHub compatible Apache 2 license text 2 years ago
README.md Add Dart Sass support 3 weeks ago
SECURITY.md Update SECURITY.md 1 month ago
bench.sh Add GOEXE to support building with different versions of `go` 3 years ago
benchSite.sh all: Fix minor typos 1 month ago
benchbep.sh Add Hugo Modules 1 year ago
bepdock.sh build: Update the temp docker script 2 years ago
go.mod build(deps): bump github.com/spf13/afero from 1.4.1 to 1.5.1 5 days ago
go.sum build(deps): bump github.com/spf13/afero from 1.4.1 to 1.5.1 5 days ago
goreleaser.yml releaser: Drop 32-bit for MacOS 4 months ago
magefile.go all: Format code with gofumpt 1 month ago
main.go all: Format code with gofumpt 1 month ago
merge-release.sh Add merge helper 3 months ago
pull-docs.sh Allow the pull-docs script to pull other than master 3 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 Tests on Linux, MacOS and Windows 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, DragonFly BSD, Open BSD, 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 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%.

If you want to compile with Sass/SCSS support use --tags extended and make sure CGO_ENABLED=1 is set in your go environment. If you don't want to have CGO enabled, you may use the following command to temporarily enable CGO only for hugo compilation:

CGO_ENABLED=1 go install --tags extended

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.

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/alecthomas/chroma MIT License
github.com/armon/go-radix MIT License
github.com/aws/aws-sdk-go Apache License 2.0
github.com/bep/debounce MIT License
github.com/bep/gitmap MIT License
github.com/bep/golibsass MIT License
github.com/bep/tmc MIT License
github.com/BurntSushi/locker The Unlicense
github.com/BurntSushi/toml MIT License
github.com/cpuguy83/go-md2man MIT License
github.com/danwakefield/fnmatch BSD 2-Clause "Simplified" License
github.com/disintegration/gift MIT License
github.com/dustin/go-humanize 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/golang-lru Mozilla Public License 2.0
github.com/hashicorp/hcl Mozilla Public License 2.0
github.com/jdkato/prose MIT License
github.com/kr/pretty 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/niklasfasching/go-org 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/PuerkitoBio/purell BSD 3-Clause "New" or "Revised" License
github.com/PuerkitoBio/urlesc BSD 3-Clause "New" or "Revised" License
github.com/rogpeppe/go-internal BSD 3-Clause "New" or "Revised" License
github.com/russross/blackfriday Simplified BSD License
github.com/rwcarlsen/goexif BSD 2-Clause "Simplified" 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/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/yuin/goldmark MIT License
github.com/yuin/goldmark-highlighting MIT License
go.opencensus.io Apache License 2.0
go.uber.org/atomic MIT License
gocloud.dev Apache License 2.0
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/oauth2 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
golang.org/x/xerrors BSD 3-Clause "New" or "Revised" License
google.golang.org/api BSD 3-Clause "New" or "Revised" License
google.golang.org/genproto Apache License 2.0
gopkg.in/ini.v1 Apache License 2.0
gopkg.in/yaml.v2 Apache License 2.0