Go Shell
Latest commit 02f2735 Dec 17, 2017 @bep bep tpl/strings: Fix broken test
Permalink
Failed to load latest commit information.
.circleci circleci: Bump to Go 1.9.2 Nov 11, 2017
.github Adjust the stale setup Dec 6, 2017
bufferpool bufpool: Add package doc Apr 9, 2016
cache cache: Add even more concurrency to test Jun 28, 2017
commands releaser: Prepare repository for 0.32-DEV Nov 27, 2017
common/types Only re-render the view(s) you're working on Oct 14, 2017
compare compare, hugolib, tpl: Add Eqer interface Aug 18, 2017
config all: Fix some govet complaints Mar 9, 2017
create all: Fix spelling Aug 7, 2017
deps metrics: Detect partialCached candidates Oct 7, 2017
docs Add Pandoc support, refactor external helpers Nov 30, 2017
docshelper Add some missing doc comments Aug 3, 2017
examples examples: Fix `now` usage in footer Sep 27, 2017
helpers Reuse the BlackFriday instance when possible Dec 16, 2017
hugofs Add some missing doc comments Aug 3, 2017
hugolib Reuse the BlackFriday instance when possible Dec 16, 2017
i18n i18n: Support unknown language codes Nov 6, 2017
livereload livereload: Fix host comparison when ports aren't present Dec 16, 2017
media Clean up lint in various packages Sep 29, 2017
metrics metrics: Reset benchmark timer Oct 7, 2017
output output: Fall back to unstranslated base template Nov 17, 2017
parser parser: Final (!) fix for issue with escaped JSON front matter Jul 8, 2017
related Clean up lint in various packages Sep 29, 2017
releaser releaser: Improve release notes front matter Oct 19, 2017
source source: Enable disabled test Nov 19, 2017
tpl tpl/strings: Fix broken test Dec 17, 2017
transform Add some missing doc comments Aug 3, 2017
utils utils: Use local logger Feb 21, 2017
watcher Add some missing doc comments Aug 3, 2017
.gitignore Remove ^M from file to make line-endings consistent Jul 21, 2017
.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 Travis and snapcraft to Go 1.9.2 Nov 7, 2017
CONTRIBUTING.md Update CONTRIBUTING to reflect Go Dep Oct 21, 2017
Dockerfile Update Dockerfile and Snap build to reflect move to dep Oct 21, 2017
Gopkg.lock vendor: Fix Humanize for multi-byte runes Nov 28, 2017
Gopkg.toml vendor: Update Chroma to v0.2.0 Nov 27, 2017
LICENSE.md Squashed 'docs/' content from commit f887bd7b Aug 10, 2017
README.md Add linebreak to README.md for better readability Oct 28, 2017
appveyor.yml Replace make with mage Oct 5, 2017
bench.sh Add GOEXE to support building with different versions of `go` Jul 15, 2017
benchSite.sh Simplify Site benchmarks Oct 18, 2017
goreleaser.yml release: CGO_ENABLED=0 Aug 28, 2017
magefile.go mage: Do not run Go Fmt check on Go tip Dec 7, 2017
main.go all: Update import paths to gohugoio/hugo Jun 13, 2017
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
snapcraft.yaml releaser: Prepare repository for 0.32-DEV Nov 27, 2017

README.md

Hugo

A Fast and Flexible Static Site Generator built with love by 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 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)

Add Hugo and its package dependencies to your go src directory.

go get -v github.com/gohugoio/hugo

Once the get completes, you should find your new hugo (or hugo.exe) executable sitting inside $GOPATH/bin/.

To update Hugo’s dependencies, use go get with the -u option.

go get -u -v github.com/gohugoio/hugo

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