No Description

Bjørn Erik Pedersen 4a39564efe Fix IsDescendant/IsAncestor for overlapping section names 2 days ago
.circleci 2ebb9f5484 Fix Go build version 1 week ago
.github 5f1aafafb4 Update feature_request.md 5 months ago
bufferpool 9e57182705 tests: Convert from testify to quicktest 7 months ago
cache 0b96aba022 commands: Add "hugo mod verify" 1 month ago
codegen 9e57182705 tests: Convert from testify to quicktest 7 months ago
commands 7204b354a9 Some minify configuration adjustments 1 week ago
common 19a8accc9f releaser: Prepare repository for 0.69.0-DEV 4 days ago
compare 9e57182705 tests: Convert from testify to quicktest 7 months ago
config 108314444b Add HTTP header support for the dev server 2 weeks ago
create eada236f87 Introduce a tree map for all content 1 month ago
deploy 51e178a6a2 deploy: Add include and exclude support for remote 2 weeks ago
deps df298558a5 Improve Tailwind/PostCSS error messages 2 weeks ago
docs b6e097cfe6 fix typo in getting started 4 days ago
docshelper 7204b354a9 Some minify configuration adjustments 1 week ago
examples d61bee5e09 examples: Fix blog not building 2 months ago
helpers 7204b354a9 Some minify configuration adjustments 1 week ago
htesting eada236f87 Introduce a tree map for all content 1 month ago
hugofs cc2a5d52a4 Pass directory name to filters in LstatIfPossible in the same way as Readdir 1 week ago
hugolib 4a39564efe Fix IsDescendant/IsAncestor for overlapping section names 2 days ago
identity 6f48146e75 identity: Fix potential infinite recursion in server change detection 4 weeks ago
langs 5914f91b6c Add languageDirection to language configuration 2 weeks ago
lazy d6f7a9e28d resources/images: Make the image cache more robust 4 months ago
livereload 2fc0abd22a Fix livereload for @import case 8 months ago
markup 7204b354a9 Some minify configuration adjustments 1 week ago
media 7204b354a9 Some minify configuration adjustments 1 week ago
metrics 5eadc4c0a8 metrics: Fix --templateMetricsHints 2 weeks ago
minifiers 7204b354a9 Some minify configuration adjustments 1 week ago
modules dce210ab56 modules: Improve "hugo mod clean" 1 month ago
navigation a3fe5e5e35 Fix Params case handling in the index, sort and where func 4 months ago
output 7204b354a9 Some minify configuration adjustments 1 week ago
parser 7204b354a9 Some minify configuration adjustments 1 week ago
publisher 7204b354a9 Some minify configuration adjustments 1 week ago
related 9e57182705 tests: Convert from testify to quicktest 7 months ago
releaser 1ce3e7d521 releaser: Include "Revert" commits in change log 6 days ago
resources 523d51948f Fix _build.list.local logic 4 days ago
scripts d20ca37005 tpl: Get rid of the custom template truth logic 3 months ago
snap 19a8accc9f releaser: Prepare repository for 0.69.0-DEV 4 days ago
source ad1d6d6406 source: Remove debug check left during development 7 months ago
temp 19a8accc9f releaser: Prepare repository for 0.69.0-DEV 4 days ago
tpl 7204b354a9 Some minify configuration adjustments 1 week ago
transform b3f0674b80 transform/livereloadinject: Add defer to livereload script tag 1 month ago
watcher 81c13171a9 Add some missing doc comments 2 years ago
.dockerignore 075b17ee1d Support Docker args TAGS, WORKDIR, CGO; speed up repetitive builds 1 year ago
.gitattributes 9c1e82085e .gitattributes: Exclude *.svg from CRLF/LF conversion 1 year ago
.gitignore 167c01530b Create lightweight forks of text/template and html/template 3 months ago
.gitmodules ea2cc26b39 Remove the theme submodule from /docs 2 years ago
.mailmap 831fbd5e40 Add .mailmap to get a more correct author log 5 years ago
.travis.yml 1d91d8e14b Update to Go 1.14.1 and 1.13.9 1 week ago
CONTRIBUTING.md 7f0ebd4a3c CONTRIBUTING: Fix note about CGO 1 month ago
Dockerfile 75c3787fc2 Add git to Dockerfile 1 month ago
LICENSE dd48277497 Add a GitHub compatible Apache 2 license text 1 year ago
README.md ee3d02134d Update dependency list in README.md 3 weeks ago
bench.sh ea5e9e346c Add GOEXE to support building with different versions of `go` 2 years ago
benchSite.sh b6ea6d07d0 Run benchmarks 3 times 2 years ago
benchbep.sh 9f5a92078a Add Hugo Modules 8 months ago
bepdock.sh 48413d76f4 build: Update the temp docker script 1 year ago
go.mod 52c159c452 Update to goldmark 1.1.25. 1 week ago
go.sum 52c159c452 Update to goldmark 1.1.25. 1 week ago
goreleaser.yml 31c9c690fd releaser: Update Go Releaser and consolidate the 2 configs 9 months ago
magefile.go 33ae621083 Update to Go 1.14 and 1.13.8 1 month ago
main.go 87b16abd93 Add HUGO_NUMWORKERMULTIPLIER 11 months ago
pull-docs.sh 9436f0b0c3 Allow the pull-docs script to pull other than master 2 years ago
requirements.txt 07f6e1499c travis: Pull docutils out into requirements.txt 2 years ago

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 |