The world’s fastest framework for building websites.
Find a file
Bjørn Erik Pedersen 6b02f5c0f4 Make resources fetched via resources.Get and similar language agnostic
With the newly released Hugo Pipes, resources fetched and processed via `resources.Get` and similar was published to the relevant language sub folder when in multilingual mode.

The thought behind that was maximum flexibility with support for `assetDir` per language.

In practice this was a bad idea:

* You get duplication of identical content, with added processing time
* You end up with path issues that seem to be hard to find a way around (`@fa-font-path` is one example)

This commit changes that. Now there is only one `assetDir` and if you, as one example, need to generate a CSS per langugage, you need to set the paths yourself.

Fixes #5017
2018-07-31 23:33:04 +02:00
.circleci releaser: Revert to the old versions of the release pipeline 2018-07-09 11:54:10 +02:00
.github
bufferpool
cache Simplify .Site.GetPage etc. 2018-07-18 00:07:20 +02:00
commands Get rid of the utils package 2018-07-22 00:35:09 +02:00
common
compare
config Fix typos 2018-07-07 12:29:56 +02:00
create
deps Make resources fetched via resources.Get and similar language agnostic 2018-07-31 23:33:04 +02:00
docs releaser: Prepare repository for 0.46-DEV 2018-07-25 08:58:54 +00:00
docshelper
examples
helpers releaser: Prepare repository for 0.46-DEV 2018-07-25 08:58:54 +00:00
hugofs
hugolib tocss/scss: Improve _ prefix handling in SCSS imports 2018-07-31 16:53:03 +02:00
i18n
langs Make resources fetched via resources.Get and similar language agnostic 2018-07-31 23:33:04 +02:00
livereload
media media: Only show deprecation warning when needed 2018-07-10 23:21:48 +02:00
metrics
output media: Allow multiple file suffixes per media type 2018-07-10 22:13:52 +02:00
parser
related
releaser
resource Make resources fetched via resources.Get and similar language agnostic 2018-07-31 23:33:04 +02:00
source
tpl tpl/partials: Add templates.Exists 2018-07-31 13:28:15 +02:00
transform
watcher
.dockerignore
.gitattributes .gitattributes: Exclude *.svg from CRLF/LF conversion 2018-07-09 21:06:15 -06:00
.gitignore
.gitmodules
.mailmap
.travis.yml
appveyor.yml
bench.sh
benchSite.sh
bepdock.sh Add temporary build script 2018-07-08 16:08:22 +02:00
CONTRIBUTING.md
Dockerfile
Gopkg.lock releaser: Bump versions for release of 0.44 2018-07-13 06:03:09 +00:00
Gopkg.toml
goreleaser-extended.yml releaser: Remove flag on Windows build 2018-07-13 08:40:09 +02:00
goreleaser.yml releaser: Revert to the old versions of the release pipeline 2018-07-09 11:54:10 +02:00
LICENSE
magefile.go
main.go
pull-docs.sh
README.md
requirements.txt
snapcraft.yaml releaser: Prepare repository for 0.46-DEV 2018-07-25 08:58:54 +00:00

Hugo

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

Prerequisite Tools

Vendored Dependencies

Hugo uses dep to vendor dependencies, but we don't commit the vendored packages themselves to the Hugo git repository. Therefore, a simple go get is not supported because the command is not vendor aware.

The simplest way is to use mage (a Make alternative for Go projects.)

Fetch from GitHub

go get github.com/magefile/mage
go get -d github.com/gohugoio/hugo
cd ${GOPATH:-$HOME/go}/src/github.com/gohugoio/hugo
mage vendor
mage 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