The world’s fastest framework for building websites.
Find a file
Bjørn Erik Pedersen 863a812e07
create: Provide .Name to the archetype templates
This value will have a better suited value to base the titles on in your archetype templates when creating bundle ´index.md` type of files.

The internal template is updates, but you will have to update any custom archetype template to use the new `.Name` variable:

```bash
---
title: "{{ replace .Name "-" " " | title }}"
date: {{ .Date }}
draft: true
---
```

Fixes #4348
2018-01-28 19:41:55 +01:00
.circleci Update to Go 1.9.3 2018-01-26 17:07:08 +01:00
.github github: Shorten the stale setup 2018-01-24 13:10:44 +01:00
bufferpool
cache
commands commands: Deprecate CLI flags canonifyURLs, pluralizeListTitles, preserveTaxonomyNames, uglyURLs 2018-01-28 17:22:08 +01:00
common/types
compare
config Add a way to disable one or more languages 2018-01-26 14:04:14 +01:00
create create: Provide .Name to the archetype templates 2018-01-28 19:41:55 +01:00
deps
docs docs: Re-generate CLI docs 2018-01-25 10:24:59 +01:00
docshelper
examples
helpers Add a way to disable one or more languages 2018-01-26 14:04:14 +01:00
hugofs
hugolib hugolib: Fix --uglyURLs from comand line regression 2018-01-28 17:03:10 +01:00
i18n
livereload
media
metrics
output hugolib, output: Fix robots.txt in multihost mode 2018-01-25 10:36:53 +01:00
parser Support pages without front matter 2018-01-26 09:17:27 +01:00
related
releaser releaser: Git info bounds checking 2018-01-11 09:39:42 +01:00
resource resource: Start Resources :counter first time they're used 2018-01-27 10:22:42 +01:00
source Fix handling of top-level page bundles 2018-01-27 19:13:34 +01:00
tpl tpl/collections: Seed random on init only 2018-01-27 18:51:12 +01:00
transform
utils
watcher
.gitignore
.gitmodules
.mailmap
.travis.yml travis: Re-enable macOS builds 2018-01-26 17:08:32 +01:00
appveyor.yml Support offline builds 2018-01-11 17:22:12 +01:00
bench.sh
benchSite.sh Run benchmarks 3 times 2018-01-14 00:49:01 +01:00
CONTRIBUTING.md Add some general code contribution criterias 2018-01-23 13:33:51 +01:00
Dockerfile
Gopkg.lock resource: Avoid some strings.ToLower in globbing 2018-01-22 11:29:33 +01:00
Gopkg.toml resource: Add Match and GetMatch 2018-01-22 10:28:12 +01:00
goreleaser.yml releaser: Fix BuildDate in release binaries 2018-01-22 11:21:58 +01:00
LICENSE.md
magefile.go resource: Add front matter metadata to Resource 2018-01-17 16:22:33 +01:00
main.go
pull-docs.sh
README.md
requirements.txt
snapcraft.yaml Update to Go 1.9.3 2018-01-26 17:07:08 +01: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