Skip to content
The world’s fastest framework for building websites.
Go Other
  1. Go 99.1%
  2. Other 0.9%
Branch: master
Clone or download

Latest commit

anthonyfok snap: Fix build error: my previous commits did not fix it
- Revert to legacy snap and my custom plugin x-nodejs for now
- Quote "@babel/cli" and add "@babel/core"
- Change bin/babel.js to bin/babel
Latest commit 9152024 May 25, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Update to Go 1.14.3 and Go 1.13.11 May 16, 2020
.github Update feature_request.md Oct 11, 2019
bufferpool tests: Convert from testify to quicktest Aug 12, 2019
cache commands: Add "hugo mod verify" Feb 19, 2020
codegen tests: Convert from testify to quicktest Aug 12, 2019
commands commands: Use WARN log level also for the early initialization May 18, 2020
common releaser: Prepare repository for 0.72.0-DEV May 25, 2020
compare tests: Convert from testify to quicktest Aug 12, 2019
config Collect HTML elements during the build to use in PurgeCSS etc. Apr 9, 2020
create Introduce a tree map for all content Feb 18, 2020
deploy deploy: Do not suppress .well-known/ directory May 14, 2020
deps Add basic "post resource publish support" Apr 7, 2020
docs releaser: Add release notes to /docs for release of 0.71.1 May 25, 2020
docshelper Some minify configuration adjustments Mar 20, 2020
examples examples: Fix blog not building Jan 19, 2020
helpers Fix GetPage on section/bundle name overlaps May 24, 2020
htesting Fix GetPage on section/bundle name overlaps May 24, 2020
hugofs Pass directory name to filters in LstatIfPossible in the same way as … Mar 19, 2020
hugolib Add some more date test cases May 24, 2020
identity Add basic "post resource publish support" Apr 7, 2020
langs Add languageDirection to language configuration Mar 10, 2020
lazy Add diagnostic hints to init timeout message Apr 27, 2020
livereload Fix livereload for @import case Jul 22, 2019
markup Add render template hooks for headings May 15, 2020
media Some minify configuration adjustments Mar 20, 2020
metrics metrics: Fix --templateMetricsHints Mar 12, 2020
minifiers Some minify configuration adjustments Mar 20, 2020
modules modules: Fix hugo mod vendor for regular file mounts Apr 7, 2020
navigation Fix Params case handling in the index, sort and where func Nov 22, 2019
output Some minify configuration adjustments Mar 20, 2020
parser Some minify configuration adjustments Mar 20, 2020
publisher Fix some missing JS class collector cases Apr 27, 2020
related related: Fix toLower Apr 21, 2020
releaser releaser: Include "Revert" commits in change log Mar 21, 2020
resources Fix Babel on Windows May 18, 2020
scripts/fork_go_templates Fix Go template script escaping May 23, 2020
snap snap: Fix build error: my previous commits did not fix it May 25, 2020
source source: Remove debug check left during development Aug 23, 2019
temp releaser: Prepare repository for 0.72.0-DEV May 25, 2020
tpl Fix Go template script escaping May 23, 2020
transform transform/livereloadinject: Add defer to livereload script tag Jan 31, 2020
watcher Add some missing doc comments Aug 3, 2017
.dockerignore Support Docker args TAGS, WORKDIR, CGO; speed up repetitive builds Feb 22, 2019
.gitattributes .gitattributes: Exclude *.svg from CRLF/LF conversion Jul 10, 2018
.gitignore Collect HTML elements during the build to use in PurgeCSS etc. Apr 9, 2020
.gitmodules Squashed 'docs/' content from commit f887bd7b Aug 10, 2017
.mailmap Add .mailmap to get a more correct author log Jan 28, 2015
.travis.yml Update to Go 1.14.3 and Go 1.13.11 May 16, 2020
CONTRIBUTING.md Typo correction Apr 7, 2020
Dockerfile Add git to Dockerfile Feb 14, 2020
LICENSE Add a GitHub compatible Apache 2 license text Apr 15, 2018
README.md Update dependency list in README.md Mar 3, 2020
bench.sh Add GOEXE to support building with different versions of `go` Jul 15, 2017
benchSite.sh Run benchmarks 3 times Jan 13, 2018
benchbep.sh Add Hugo Modules Jul 24, 2019
bepdock.sh build: Update the temp docker script Sep 24, 2018
go.mod Upgrade chroma to 0.7.3 to fix invalid css May 9, 2020
go.sum Upgrade chroma to 0.7.3 to fix invalid css May 9, 2020
goreleaser.yml releaser: Update Go Releaser and consolidate the 2 configs Jun 10, 2019
magefile.go Update to Go 1.14 and 1.13.8 Feb 26, 2020
main.go Add HUGO_NUMWORKERMULTIPLIER Apr 5, 2019
pull-docs.sh Allow the pull-docs script to pull other than master Sep 23, 2017
requirements.txt travis: Pull docutils out into requirements.txt Aug 11, 2017

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, 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%.

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
You can’t perform that action at this time.