The world’s fastest framework for building websites.
Find a file
Bjørn Erik Pedersen aaaf1c8df5 Squashed 'docs/' changes from 417593493..4d936aee6
4d936aee6 Fix function signatures
8182a27ed Simplify example usage of apply function

git-subtree-dir: docs
git-subtree-split: 4d936aee622b779ef5541154750b51051dc0bf14
2023-10-29 11:33:05 +01:00
.github Squashed 'docs/' changes from 85befbb4d..c43daf45f 2023-07-29 11:15:54 +02:00
.vscode Squashed 'docs/' changes from 392668f4f..32cb8785e 2022-11-17 16:14:29 +01:00
_vendor Squashed 'docs/' changes from 7ef2dbce4..cb18a5183 2023-10-20 09:42:39 +02:00
archetypes Squashed 'docs/' changes from 7ef2dbce4..cb18a5183 2023-10-20 09:42:39 +02:00
config Squashed 'docs/' changes from cb18a5183..417593493 2023-10-27 10:06:44 +02:00
content/en Squashed 'docs/' changes from 417593493..4d936aee6 2023-10-29 11:33:05 +01:00
data Squashed 'docs/' changes from 7ef2dbce4..cb18a5183 2023-10-20 09:42:39 +02:00
layouts Squashed 'docs/' changes from 417593493..4d936aee6 2023-10-29 11:33:05 +01:00
src Squashed 'docs/' content from commit fdea5430f 2019-10-21 10:22:28 +02:00
static Squashed 'docs/' changes from 6e32d0591..39af43ef1 2023-05-22 16:43:12 +02:00
.cspell.json Squashed 'docs/' changes from 392668f4f..32cb8785e 2022-11-17 16:14:29 +01:00
.editorconfig Squashed 'docs/' content from commit fdea5430f 2019-10-21 10:22:28 +02:00
.gitignore Squashed 'docs/' changes from e5aa641a6..392668f4f 2022-09-13 20:34:24 +02:00
.markdownlint.yaml Squashed 'docs/' changes from 392668f4f..32cb8785e 2022-11-17 16:14:29 +01:00
.markdownlintignore Squashed 'docs/' changes from 392668f4f..32cb8785e 2022-11-17 16:14:29 +01:00
.textlintignore Squashed 'docs/' changes from 392668f4f..32cb8785e 2022-11-17 16:14:29 +01:00
go.mod Squashed 'docs/' changes from 7ef2dbce4..cb18a5183 2023-10-20 09:42:39 +02:00
go.sum Squashed 'docs/' changes from 7ef2dbce4..cb18a5183 2023-10-20 09:42:39 +02:00
hugo.toml Squashed 'docs/' changes from cb18a5183..417593493 2023-10-27 10:06:44 +02:00
hugo.work Squashed 'docs/' changes from 2c0125b52..1214f6ffb 2023-01-17 12:51:01 +01:00
hugo_stats.json Squashed 'docs/' changes from bcc4f9324..4c81c6c2a 2021-06-08 18:46:58 +02:00
hugoreleaser.toml Squashed 'docs/' changes from e5aa641a6..392668f4f 2022-09-13 20:34:24 +02:00
LICENSE.md Squashed 'docs/' content from commit fdea5430f 2019-10-21 10:22:28 +02:00
netlify.toml Squashed 'docs/' changes from 7ef2dbce4..cb18a5183 2023-10-20 09:42:39 +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 2c0125b52..1214f6ffb 2023-01-17 12:51:01 +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 codebase 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.

Edit the theme

If you want to do docs-related theme changes, the simplest way is to have both hugoDocs and gohugoioTheme cloned as sibling directories, and then run:

HUGO_MODULE_WORKSPACE=hugo.work hugo server --ignoreVendorPaths "**"

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