The world’s fastest framework for building websites.
Go to file
Bjørn Erik Pedersen 7eb0e10a80 Squashed 'docs/' changes from 710856e5a..6ebb5dad9
6ebb5dad9 Remove file
27cc23ef4 Hugo 0.84.4
94dccbfa4 Merge branch 'tempv0.84.4'
e9d8b61fb releaser: Add release notes to /docs for release of 0.84.4
51e472005 Improve readability of examples on shortcode templates page
0aef26479 Fix lookup order typos (#1484)
534a527fe Fix two typos (#1483)
394aabd5a Higo "0.84.3
03ee92c1c Merge branch 'tempv0.84.3'
96a8be0f1 releaser: Add release notes to /docs for release of 0.84.3
9a770323f Update index.md
7f65cfcbe Hugo 0.84.2
444422515 releaser: Add release notes to /docs for release of 0.84.2
a2f29c5d8 modules: Add module.import.noMounts config
e00e4a7e7 releaser: Add release notes to /docs for release of 0.84.2
af04b53b3 modules: Add module.import.noMounts config
f7d5669c7 Remove Appernetic (#1481)
14f8d4029 Clarify interaction of sections and top-level leaf bundles
d140b6a62 Update lookup-order.md
399904959 Update shortcode-templates.md
e78aa4865 Hugo 0.84.1
35d7c1c22 Merge branch 'tempv0.84.1'
a6be65b0d releaser: Add release notes to /docs for release of 0.84.1
7b3b3ca45 Hugo 0.84.0 News Grammar fixes
cbc23bf5a Remove trailing newlines
69349198d Fix erroridf docs
dbc1157c1 Fix missing deep

git-subtree-dir: docs
git-subtree-split: 6ebb5dad9a87655196c0990d88d50a2248df5c54
2021-07-04 16:34:26 +02:00
.github Squashed 'docs/' changes from 9be494de3..ac2c4a487 2020-06-16 14:18:51 +02:00
_vendor Squashed 'docs/' changes from fb551cc75..bcc4f9324 2021-05-01 11:45:45 +02:00
archetypes Squashed 'docs/' content from commit fdea5430f 2019-10-21 10:22:28 +02:00
config Squashed 'docs/' changes from d343ebf71..bb15e9804 2021-02-23 17:39:59 +01:00
content Squashed 'docs/' changes from 710856e5a..6ebb5dad9 2021-07-04 16:34:26 +02:00
data Squashed 'docs/' changes from 3a923e155..710856e5a 2021-06-18 17:49:54 +02:00
layouts Squashed 'docs/' changes from 3a923e155..710856e5a 2021-06-18 17:49:54 +02:00
resources Squashed 'docs/' changes from 3a923e155..710856e5a 2021-06-18 17:49:54 +02:00
src Squashed 'docs/' content from commit fdea5430f 2019-10-21 10:22:28 +02:00
static Squashed 'docs/' changes from 57c1d1a67..1de7a358c 2020-11-27 09:26:24 +01:00
.editorconfig Squashed 'docs/' content from commit fdea5430f 2019-10-21 10:22:28 +02:00
.gitignore Squashed 'docs/' changes from bcc4f9324..4c81c6c2a 2021-06-08 18:46:58 +02:00
config.toml Squashed 'docs/' changes from 3a923e155..710856e5a 2021-06-18 17:49:54 +02:00
go.mod Squashed 'docs/' changes from 9cece6640..fb551cc75 2021-04-20 20:21:45 +02:00
go.sum Squashed 'docs/' changes from 9cece6640..fb551cc75 2021-04-20 20:21:45 +02:00
hugo_stats.json Squashed 'docs/' changes from bcc4f9324..4c81c6c2a 2021-06-08 18:46:58 +02:00
LICENSE.md Squashed 'docs/' content from commit fdea5430f 2019-10-21 10:22:28 +02:00
netlify.toml Squashed 'docs/' changes from 710856e5a..6ebb5dad9 2021-07-04 16:34:26 +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