github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-07 20:30:36 -05:00
Code Issues Projects Releases Packages Wiki Activity
The world’s fastest framework for building websites.
7787 commits 141 branches 301 tags 201 MiB
Go 95.9%
JavaScript 3.1%
HTML 0.9%
Find a file
Bjørn Erik Pedersen d297c8e1b5
docs: Regenerate CLI docs
2023-07-30 18:54:08 +02:00
.circleci circleci: Add github.com to known hosts 2023-05-23 10:12:16 +02:00
.github Squashed 'docs/' changes from 85befbb4d..c43daf45f 2023-07-29 11:15:54 +02:00
bufferpool all: gofmt -w -r 'interface{} -> any' . 2022-03-17 22:03:27 +01:00
cache all: Fix typos in function names and comments 2023-06-19 09:26:29 +02:00
codegen Misc doc, code refactoring to improve documentation 2023-01-04 18:01:26 +01:00
commands commands: Update cacheDir description 2023-07-29 22:09:55 +02:00
common Deprecate taxonomyTerm 2023-07-28 15:14:24 +02:00
compare Add page fragments support to Related 2023-02-21 17:56:41 +01:00
config Deprecate taxonomyTerm 2023-07-28 15:14:24 +02:00
create Create a struct with all of Hugo's config options 2023-05-16 18:01:29 +02:00
deploy Fix broken nodeploy setup 2023-06-23 12:40:43 +02:00
deps Replace the old log setup, with structured logging etc. 2023-06-18 13:03:04 +02:00
docs docs: Regenerate CLI docs 2023-07-30 18:54:08 +02:00
docshelper all: gofmt -w -r 'interface{} -> any' . 2022-03-17 22:03:27 +01:00
helpers Use os.UserCacheDir as first fallback if cacheDir is not set 2023-07-27 20:59:47 +02:00
htesting all: Fix typos in function names and comments 2023-06-19 09:26:29 +02:00
hugofs Create hugo_stats.json if it's mounted but does not exists 2023-07-19 19:50:37 +02:00
hugolib Fix so temporary images do not get published 2023-07-30 18:52:34 +02:00
identity all: Fix comments for exported functions and packages 2023-05-18 21:25:27 +02:00
langs Restore language.disabled config 2023-07-08 16:51:48 +02:00
lazy all: Fix comments for exported functions and packages 2023-05-18 21:25:27 +02:00
livereload all: Fix typos in function names and comments 2023-06-19 09:26:29 +02:00
markup Don't panic on invalid security whitelist regexp 2023-06-28 08:57:28 +02:00
media Create a struct with all of Hugo's config options 2023-05-16 18:01:29 +02:00
metrics Only invoke a given cached partial once 2023-01-25 17:35:23 +01:00
minifiers minifiers: Make sure JS.Version always has a value 2023-05-24 12:42:56 +02:00
modules Create hugo_stats.json if it's mounted but does not exists 2023-07-19 19:50:37 +02:00
navigation Create a struct with all of Hugo's config options 2023-05-16 18:01:29 +02:00
output Fix regression when config for OutputFormat.BaseName is an empty string 2023-05-23 19:23:39 +02:00
parser Fix setting config from env with complex (e.g. YAML) strings 2023-07-16 18:08:23 +02:00
publisher publisher: Improve class collector for dynamic classes 2023-07-19 19:50:37 +02:00
related Create a struct with all of Hugo's config options 2023-05-16 18:01:29 +02:00
releaser Remove reference to Goreleaser in code comment 2023-01-03 20:25:44 +01:00
resources Fix so temporary images do not get published 2023-07-30 18:52:34 +02:00
scripts/fork_go_templates Replace deprecated ioutil with io and os 2023-03-01 16:28:43 +01:00
snap snap: Set cache location to $HOME/.cache/hugo_cache 2023-07-27 12:43:52 -07:00
source Misc permalinks adjustments 2023-06-29 10:14:19 +02:00
testscripts Use os.UserCacheDir as first fallback if cacheDir is not set 2023-07-27 20:59:47 +02:00
tpl tpl/collections: Add BenchmarkWhereOps 2023-07-28 10:08:13 +02:00
transform Replace the old log setup, with structured logging etc. 2023-06-18 13:03:04 +02:00
watcher Run gofmt -s on source files 2023-03-12 10:32:29 +01:00
.dockerignore Support Docker args TAGS, WORKDIR, CGO; speed up repetitive builds 2019-02-22 11:53:17 -08:00
.gitattributes .gitattributes: Exclude *.svg from CRLF/LF conversion 2018-07-09 21:06:15 -06:00
.gitignore Create a struct with all of Hugo's config options 2023-05-16 18:01:29 +02:00
.gitmodules
.mailmap
bench.sh
benchbep.sh Add Hugo Modules 2019-07-24 09:35:53 +02:00
benchSite.sh all: Fix minor typos 2020-12-16 12:11:32 +01:00
bepdock.sh build: Update the temp docker script 2018-09-24 12:41:12 +02:00
CONTRIBUTING.md Update CONTRIBUTING.md 2023-01-31 08:08:52 +01:00
Dockerfile Update Go and Alpine version in Dockerfile 2022-10-19 19:58:25 +02:00
go.mod Squashed 'docs/' changes from 85befbb4d..c43daf45f 2023-07-29 11:15:54 +02:00
go.sum Squashed 'docs/' changes from 85befbb4d..c43daf45f 2023-07-29 11:15:54 +02:00
hugoreleaser.env releaser: Prepare repository for 0.116.0-DEV 2023-07-20 07:02:18 +00:00
hugoreleaser.toml all: Fix some typos 2023-06-19 09:28:10 +02:00
LICENSE license: Add copyright info 2022-08-28 12:55:47 +02:00
magefile.go github: Fix Windows build 2023-06-01 09:54:40 +02:00
main.go Fix some recently introduced error handling issues 2023-05-18 12:47:23 +02:00
main_test.go Use os.UserCacheDir as first fallback if cacheDir is not set 2023-07-27 20:59:47 +02:00
merge-release.sh Add merge helper 2020-10-08 19:32:53 +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 readme: Fix link 2023-07-30 11:06:31 +02:00
release-hook-post-linux.sh Add linux/arm64 extended to release setup 2022-08-28 18:23:01 +02:00
SECURITY.md Update SECURITY.md 2020-12-22 10:09:59 +01:00
watchtestscripts.sh Create a struct with all of Hugo's config options 2023-05-16 18:01:29 +02:00

README.md

Hugo

A fast and flexible static site generator built with love by bep, spf13, and friends in Go.

GoDoc Tests on Linux, MacOS and Windows Go Report Card

Website | Installation | Documentation | Support | Contributing | Twitter

Overview

Hugo is a static site generator written in Go, optimized for speed and designed for flexibility. With its advanced templating system and fast asset pipelines, Hugo renders a complete site in seconds, often less.

Due to its flexible framework, multilingual support, and powerful taxonomy system, Hugo is widely used to create:

  • Corporate, government, nonprofit, education, news, event, and project sites
  • Documentation sites
  • Image portfolios
  • Landing pages
  • Business, professional, and personal blogs
  • Resumes and CVs

Use Hugo's embedded web server during development to instantly see changes to content, structure, behavior, and presentation. Then deploy the site to your host, or push changes to your Git provider for automated builds and deployment.

Hugo's fast asset pipelines include:

  • CSS bundling – transpilation (Sass), tree shaking, minification, source maps, SRI hashing, and PostCSS integration
  • JavaScript bundling – transpilation (TypeScript, JSX), tree shaking, minification, source maps, and SRI hashing
  • Image processing – convert, resize, crop, rotate, adjust colors, apply filters, overlay text and images, and extract EXIF data

And with Hugo Modules, you can share content, assets, data, translations, themes, templates, and configuration with other projects via public or private Git repositories.

Sponsors

 

Linode           CloudCannon

 

Installation

Install Hugo from a prebuilt binary, package manager, or package repository. Please see the installation instructions for your operating system:

Build from source

Hugo is available in two editions: standard and extended. With the extended edition you can:

  • Encode to the WebP format when processing images. You can decode WebP images with either edition.
  • Transpile Sass to CSS using the embedded LibSass transpiler. The extended edition is not required to use the Dart Sass transpiler.

Prerequisites to build Hugo from source:

  • Standard edition: Go 1.19 or later
  • Extended edition: Go 1.19 or later, and GCC

Build the standard edition:

go install github.com/gohugoio/hugo@latest

Build the extended edition:

CGO_ENABLED=1 go install -tags extended github.com/gohugoio/hugo@latest

Documentation

Hugo's documentation includes installation instructions, a quick start guide, conceptual explanations, reference information, and examples.

Please submit documentation issues and pull requests to the documentation repository.

Support

Please do not use the issue queue for questions or troubleshooting. Unless you are certain that your issue is a software defect, use the forum.

Hugo’s forum is an active community of users and developers who answer questions, share knowledge, and provide examples. A quick search of over 20,000 topics will often answer your question. Please be sure to read about requesting help before asking your first question.

Contributing

You can contribute to the Hugo project by:

Please submit documentation issues and pull requests to the documentation repository.

If you have an idea for an enhancement or new feature, create a new topic on the forum in the "Feature" category. This will help you to:

  • Determine if the capability already exists
  • Measure interest
  • Refine the concept

If there is sufficient interest, create a proposal. Do not submit a pull request until the project lead accepts the proposal.

For a complete guide to contributing to Hugo, see the Contribution Guide.

Dependencies

Hugo stands on the shoulders of great open source libraries. Run hugo env --logLevel info to display a list of dependencies.

See current dependencies 
cloud.google.com/go/compute/metadata="v0.2.3"
cloud.google.com/go/iam="v1.1.0"
cloud.google.com/go/storage="v1.30.1"
cloud.google.com/go="v0.110.2"
github.com/Azure/azure-sdk-for-go/sdk/azcore="v1.6.1"
github.com/Azure/azure-sdk-for-go/sdk/azidentity="v1.3.0"
github.com/Azure/azure-sdk-for-go/sdk/internal="v1.3.0"
github.com/Azure/azure-sdk-for-go/sdk/storage/azblob="v1.0.0"
github.com/Azure/go-autorest/autorest/to="v0.4.0"
github.com/AzureAD/microsoft-authentication-library-for-go="v1.0.0"
github.com/BurntSushi/locker="v0.0.0-20171006230638-a6e239ea1c69"
github.com/PuerkitoBio/purell="v1.1.1"
github.com/PuerkitoBio/urlesc="v0.0.0-20170810143723-de5bf2ad4578"
github.com/alecthomas/chroma/v2="v2.7.0"
github.com/armon/go-radix="v1.0.0"
github.com/aws/aws-sdk-go-v2/aws/protocol/eventstream="v1.4.10"
github.com/aws/aws-sdk-go-v2/config="v1.18.27"
github.com/aws/aws-sdk-go-v2/credentials="v1.13.26"
github.com/aws/aws-sdk-go-v2/feature/ec2/imds="v1.13.4"
github.com/aws/aws-sdk-go-v2/feature/s3/manager="v1.11.70"
github.com/aws/aws-sdk-go-v2/internal/configsources="v1.1.34"
github.com/aws/aws-sdk-go-v2/internal/endpoints/v2="v2.4.28"
github.com/aws/aws-sdk-go-v2/internal/ini="v1.3.35"
github.com/aws/aws-sdk-go-v2/internal/v4a="v1.0.26"
github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding="v1.9.11"
github.com/aws/aws-sdk-go-v2/service/internal/checksum="v1.1.29"
github.com/aws/aws-sdk-go-v2/service/internal/presigned-url="v1.9.28"
github.com/aws/aws-sdk-go-v2/service/internal/s3shared="v1.14.3"
github.com/aws/aws-sdk-go-v2/service/s3="v1.35.0"
github.com/aws/aws-sdk-go-v2/service/sso="v1.12.12"
github.com/aws/aws-sdk-go-v2/service/ssooidc="v1.14.12"
github.com/aws/aws-sdk-go-v2/service/sts="v1.19.2"
github.com/aws/aws-sdk-go-v2="v1.18.1"
github.com/aws/aws-sdk-go="v1.44.284"
github.com/aws/smithy-go="v1.13.5"
github.com/bep/clocks="v0.5.0"
github.com/bep/debounce="v1.2.0"
github.com/bep/gitmap="v1.1.2"
github.com/bep/goat="v0.5.0"
github.com/bep/godartsass/v2="v2.0.0"
github.com/bep/godartsass="v1.2.0"
github.com/bep/golibsass="v1.1.1"
github.com/bep/gowebp="v0.2.0"
github.com/bep/lazycache="v0.2.0"
github.com/bep/logg="v0.2.0"
github.com/bep/mclib="v1.20400.20402"
github.com/bep/overlayfs="v0.6.0"
github.com/bep/simplecobra="v0.3.2"
github.com/bep/tmc="v0.5.1"
github.com/clbanning/mxj/v2="v2.5.7"
github.com/cli/safeexec="v1.0.1"
github.com/cpuguy83/go-md2man/v2="v2.0.2"
github.com/disintegration/gift="v1.2.1"
github.com/dlclark/regexp2="v1.10.0"
github.com/dustin/go-humanize="v1.0.1"
github.com/evanw/esbuild="v0.18.5"
github.com/fatih/color="v1.15.0"
github.com/frankban/quicktest="v1.14.5"
github.com/fsnotify/fsnotify="v1.6.0"
github.com/getkin/kin-openapi="v0.118.0"
github.com/ghodss/yaml="v1.0.0"
github.com/go-openapi/jsonpointer="v0.19.6"
github.com/go-openapi/swag="v0.22.3"
github.com/gobuffalo/flect="v1.0.2"
github.com/gobwas/glob="v0.2.3"
github.com/gohugoio/go-i18n/v2="v2.1.3-0.20210430103248-4c28c89f8013"
github.com/gohugoio/locales="v0.14.0"
github.com/gohugoio/localescompressed="v1.0.1"
github.com/golang-jwt/jwt/v4="v4.5.0"
github.com/golang/groupcache="v0.0.0-20210331224755-41bb18bfe9da"
github.com/golang/protobuf="v1.5.3"
github.com/google/go-cmp="v0.5.9"
github.com/google/s2a-go="v0.1.4"
github.com/google/uuid="v1.3.0"
github.com/google/wire="v0.5.0"
github.com/googleapis/enterprise-certificate-proxy="v0.2.5"
github.com/googleapis/gax-go/v2="v2.11.0"
github.com/gorilla/websocket="v1.5.0"
github.com/hairyhenderson/go-codeowners="v0.3.0"
github.com/hashicorp/golang-lru/v2="v2.0.1"
github.com/invopop/yaml="v0.1.0"
github.com/jdkato/prose="v1.2.1"
github.com/jmespath/go-jmespath="v0.4.0"
github.com/josharian/intern="v1.0.0"
github.com/kr/pretty="v0.3.1"
github.com/kr/text="v0.2.0"
github.com/kylelemons/godebug="v1.1.0"
github.com/kyokomi/emoji/v2="v2.2.12"
github.com/mailru/easyjson="v0.7.7"
github.com/marekm4/color-extractor="v1.2.0"
github.com/mattn/go-colorable="v0.1.13"
github.com/mattn/go-isatty="v0.0.19"
github.com/mattn/go-runewidth="v0.0.9"
github.com/mitchellh/hashstructure="v1.1.0"
github.com/mitchellh/mapstructure="v1.5.0"
github.com/mohae/deepcopy="v0.0.0-20170929034955-c48cc78d4826"
github.com/muesli/smartcrop="v0.3.0"
github.com/niklasfasching/go-org="v1.7.0"
github.com/olekukonko/tablewriter="v0.0.5"
github.com/pelletier/go-toml/v2="v2.0.8"
github.com/perimeterx/marshmallow="v1.1.4"
github.com/pkg/browser="v0.0.0-20210911075715-681adbf594b8"
github.com/pkg/errors="v0.9.1"
github.com/rogpeppe/go-internal="v1.10.1-0.20230508101108-a4f6fabd84c5"
github.com/russross/blackfriday/v2="v2.1.0"
github.com/rwcarlsen/goexif="v0.0.0-20190401172101-9e8deecbddbd"
github.com/sanity-io/litter="v1.5.5"
github.com/sass/dart-sass/compiler="1.63.6"
github.com/sass/dart-sass/implementation="1.63.6"
github.com/sass/dart-sass/protocol="2.1.0"
github.com/sass/libsass="3.6.5"
github.com/spf13/afero="v1.9.5"
github.com/spf13/cast="v1.5.1"
github.com/spf13/cobra="v1.7.0"
github.com/spf13/fsync="v0.9.0"
github.com/spf13/pflag="v1.0.5"
github.com/tdewolff/minify/v2="v2.12.7"
github.com/tdewolff/parse/v2="v2.6.6"
github.com/webmproject/libwebp="v1.2.4"
github.com/yuin/goldmark="v1.5.4"
go.opencensus.io="v0.24.0"
go.uber.org/atomic="v1.11.0"
go.uber.org/automaxprocs="v1.5.2"
gocloud.dev="v0.30.0"
golang.org/x/crypto="v0.10.0"
golang.org/x/exp="v0.0.0-20230321023759-10a507213a29"
golang.org/x/image="v0.8.0"
golang.org/x/mod="v0.10.0"
golang.org/x/net="v0.11.0"
golang.org/x/oauth2="v0.9.0"
golang.org/x/sync="v0.3.0"
golang.org/x/sys="v0.9.0"
golang.org/x/text="v0.10.0"
golang.org/x/tools="v0.9.3"
golang.org/x/xerrors="v0.0.0-20220907171357-04be3eba64a2"
google.golang.org/api="v0.128.0"
google.golang.org/appengine="v1.6.7"
google.golang.org/genproto/googleapis/api="v0.0.0-20230530153820-e85fd2cbaebc"
google.golang.org/genproto/googleapis/rpc="v0.0.0-20230530153820-e85fd2cbaebc"
google.golang.org/genproto="v0.0.0-20230530153820-e85fd2cbaebc"
google.golang.org/grpc="v1.56.0"
google.golang.org/protobuf="v1.30.0"
gopkg.in/yaml.v2="v2.4.0"
gopkg.in/yaml.v3="v3.0.1"
software.sslmate.com/src/go-pkcs12="v0.2.0"