The world’s fastest framework for building websites.
Find a file
2017-11-05 10:20:30 +01:00
.circleci circleci: Must go get mage 2017-10-19 07:26:27 +02:00
bufferpool bufpool: Add package doc 2016-04-10 01:34:15 +02:00
cache cache: Add even more concurrency to test 2017-06-28 22:47:28 +02:00
commands releaser: Prepare repository for 0.31-DEV 2017-10-19 11:35:38 +00:00
common/types Only re-render the view(s) you're working on 2017-10-14 13:40:43 +02:00
compare compare, hugolib, tpl: Add Eqer interface 2017-08-18 07:36:32 +02:00
config all: Fix some govet complaints 2017-03-09 14:18:12 +01:00
create all: Fix spelling 2017-08-07 20:19:24 +02:00
deps metrics: Detect partialCached candidates 2017-10-07 18:00:07 +02:00
docs Add support for height argument to figure shortcode 2017-10-29 20:46:57 +01:00
docshelper Add some missing doc comments 2017-08-03 15:57:51 +02:00
examples examples: Fix now usage in footer 2017-09-27 08:42:44 +02:00
helpers releaser: Prepare repository for 0.31-DEV 2017-10-19 11:35:38 +00:00
hugofs Add some missing doc comments 2017-08-03 15:57:51 +02:00
hugolib Add support for height argument to figure shortcode 2017-10-29 20:46:57 +01:00
i18n Revert "i18n: Prevent data race in lang code handling" 2017-11-05 10:20:30 +01:00
livereload livereload: Maintain the scroll position if possible 2017-08-22 20:26:33 +02:00
media Clean up lint in various packages 2017-09-29 16:23:16 +02:00
metrics metrics: Reset benchmark timer 2017-10-07 20:41:25 +02:00
output Clean up lint in various packages 2017-09-29 16:23:16 +02:00
parser parser: Final (!) fix for issue with escaped JSON front matter 2017-07-08 18:43:36 +02:00
related Clean up lint in various packages 2017-09-29 16:23:16 +02:00
releaser releaser: Improve release notes front matter 2017-10-19 12:34:03 +02:00
source Clean up lint in various packages 2017-09-29 16:23:16 +02:00
tpl tpl/math: Refactor Mod with cast 2017-10-30 21:55:36 +01:00
transform Add some missing doc comments 2017-08-03 15:57:51 +02:00
utils utils: Use local logger 2017-02-21 09:41:56 +01:00
watcher Add some missing doc comments 2017-08-03 15:57:51 +02:00
.gitignore Remove ^M from file to make line-endings consistent 2017-07-21 02:41:07 -06:00
.gitmodules Remove the theme submodule from /docs 2017-08-10 14:54:19 +02:00
.mailmap Add .mailmap to get a more correct author log 2015-01-28 16:50:36 +01:00
.travis.yml Bump Go versions in Travis config 2017-10-05 18:50:36 +02:00
appveyor.yml Replace make with mage 2017-10-05 10:53:02 +02:00
bench.sh Add GOEXE to support building with different versions of go 2017-07-16 00:35:15 +02:00
benchSite.sh Simplify Site benchmarks 2017-10-18 16:46:55 +02:00
CONTRIBUTING.md Update CONTRIBUTING to reflect Go Dep 2017-10-21 19:30:23 +02:00
Dockerfile Update Dockerfile and Snap build to reflect move to dep 2017-10-21 19:30:23 +02:00
Gopkg.lock Update toml dependency revision in Gopkg.lock too 2017-10-23 21:15:44 +02:00
Gopkg.toml Update toml dep to fetch its latest master branch instead of v0.3.0 2017-10-23 19:44:41 +02:00
goreleaser.yml release: CGO_ENABLED=0 2017-08-28 11:46:03 +02:00
LICENSE.md Change the license to Apache 2.0 2015-11-23 22:16:36 -05:00
magefile.go mage: Skip Check on Go 1.8 2017-10-21 19:30:23 +02:00
main.go all: Update import paths to gohugoio/hugo 2017-06-13 18:42:45 +02:00
pull-docs.sh Allow the pull-docs script to pull other than master 2017-09-23 10:13:40 +02:00
README.md Add linebreak to README.md for better readability 2017-10-28 12:57:15 +02:00
requirements.txt travis: Pull docutils out into requirements.txt 2017-08-11 18:39:04 +02:00
snapcraft.yaml Update Dockerfile and Snap build to reflect move to dep 2017-10-21 19:30:23 +02:00

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 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)

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 Hugos 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