The world’s fastest framework for building websites.
Find a file
Bjørn Erik Pedersen 6aa5c9117f Squashed 'docs/' changes from ac2c4a487..cfd74b57d
cfd74b57d Add a config file update step.
5957d8815 Wrap cache configuration in code-toggle
914405c0e capitalization and indentation fix for taxonomies page (#1159)
223b80f42 Fix page kinds shortcode not rendering on Taxonomies page (#1158)
a9b6fa984 Clarify weight description.
29e121681 Warn about zero weights in front matter.
27ce7ba8c Release 0.73.0
e9596b2ee Merge branch 'temp73'
074a270cd releaser: Add release notes to /docs for release of 0.73.0
4f56a9fc0 width fix of expanding code box in documentation (#1156)
f27254d60 css fix of expanding code box in documentation (#1155)
43b576178 Fix incorrect directory name in quick-start (#1154)
16726eacf Add GroupByLastmod
73c31758e Fix for broken link again (#1151)
d07067295 Fix broken link (#1144)
bc0b484d1 Rename taxonomy kinds from taxonomy to term, taxonomyTerm to taxonomy
674d71842 Fix Typo on Docker section of installation page
b87778165 Merge commit 'efa74c5c6e6ff1daddeb5834ea7c69bed2acf171'
c7cdebed3 tpl/crypto: Add hmac
260130cc0 Allow hook template per section/type
1f70519d8 releaser: Add release notes to /docs for release of 0.72.0
8516d540c Merge commit '9e1dcefc5f559944b70d2fa520f6acd5c56a69f2'
c49195c69 common/maps: Add Scratch.Values
78072df81 Add redirect support to the server
90ca0af6b Fix typo in install instructions

git-subtree-dir: docs
git-subtree-split: cfd74b57d968d98f88d3ddaee651d9cbe79b7ce1
2020-07-07 06:58:43 +02:00
.github Squashed 'docs/' changes from 9be494de3..ac2c4a487 2020-06-16 14:18:51 +02:00
_vendor Squashed 'docs/' changes from ac2c4a487..cfd74b57d 2020-07-07 06:58:43 +02:00
archetypes Squashed 'docs/' content from commit fdea5430f 2019-10-21 10:22:28 +02:00
config Squashed 'docs/' changes from 6c2195936..9be494de3 2020-05-31 12:43:23 +02:00
content Squashed 'docs/' changes from ac2c4a487..cfd74b57d 2020-07-07 06:58:43 +02:00
data Squashed 'docs/' changes from ac2c4a487..cfd74b57d 2020-07-07 06:58:43 +02:00
layouts Squashed 'docs/' changes from ac2c4a487..cfd74b57d 2020-07-07 06:58:43 +02:00
resources Squashed 'docs/' changes from ac2c4a487..cfd74b57d 2020-07-07 06:58:43 +02:00
src Squashed 'docs/' content from commit fdea5430f 2019-10-21 10:22:28 +02:00
static Squashed 'docs/' changes from 54f0e8776..bd0e15bb6 2020-01-05 11:13:09 +01:00
.editorconfig Squashed 'docs/' content from commit fdea5430f 2019-10-21 10:22:28 +02:00
.gitignore Squashed 'docs/' content from commit fdea5430f 2019-10-21 10:22:28 +02:00
config.toml Squashed 'docs/' changes from 6c2195936..9be494de3 2020-05-31 12:43:23 +02:00
go.mod Squashed 'docs/' changes from 6c2195936..9be494de3 2020-05-31 12:43:23 +02:00
go.sum Squashed 'docs/' changes from 6c2195936..9be494de3 2020-05-31 12:43:23 +02:00
LICENSE.md Squashed 'docs/' content from commit fdea5430f 2019-10-21 10:22:28 +02:00
netlify.toml Squashed 'docs/' changes from ac2c4a487..cfd74b57d 2020-07-07 06:58:43 +02:00
pull-theme.sh Squashed 'docs/' content from commit fdea5430f 2019-10-21 10:22:28 +02:00
README.md Squashed 'docs/' changes from 51c4f3184..af4b7ac5b 2019-12-15 10:35:09 +01:00

Netlify Status PRs Welcome

Hugo Docs

Documentation site for Hugo, the very fast and flexible static site generator built with love in Go.

Contributing

We welcome contributions to Hugo of any kind including documentation, suggestions, bug reports, pull requests etc. Also check out our contribution guide. We would love to hear from you.

Note that this repository contains solely the documentation for Hugo. For contributions that aren't documentation-related please refer to the hugo repository.

Pull requests shall only contain changes to the actual documentation. However, changes on the code base of Hugo and the documentation shall be a single, atomic pull request in the hugo repository.

Spelling fixes are most welcomed, and if you want to contribute longer sections to the documentation, it would be great if you had the following criteria in mind when writing:

  • Short is good. People go to the library to read novels. If there is more than one way to do a thing in Hugo, describe the current best practice (avoid "… but you can also do …" and "… in older versions of Hugo you had to …".
  • For example, try to find short snippets that teaches people about the concept. If the example is also useful as-is (copy and paste), then great. Don't list long and similar examples just so people can use them on their sites.
  • Hugo has users from all over the world, so easy to understand and simple English is good.

Branches

  • The master branch is where the site is automatically built from, and is the place to put changes relevant to the current Hugo version.
  • The next branch is where we store changes that are related to the next Hugo release. This can be previewed here: https://next--gohugoio.netlify.com/

Build

To view the documentation site locally, you need to clone this repository:

git clone https://github.com/gohugoio/hugoDocs.git

Also note that the documentation version for a given version of Hugo can also be found in the /docs sub-folder of the Hugo source repository.

Then to view the docs in your browser, run Hugo and open up the link:

▶ hugo server

Started building sites ...
.
.
Serving pages from memory
Web Server is available at http://localhost:1313/ (bind address 127.0.0.1)
Press Ctrl+C to stop