The world’s fastest framework for building websites.
Find a file
Bjørn Erik Pedersen 534ae9c57a Squashed 'docs/' changes from d3eb97a33..4895c29c5
4895c29c5 Document strings.Count function

git-subtree-dir: docs
git-subtree-split: 4895c29c5b1e090eea69dc6223b2e20e3b934a6f
2020-09-13 21:58:53 +02:00
.github Squashed 'docs/' changes from 9be494de3..ac2c4a487 2020-06-16 14:18:51 +02:00
_vendor Squashed 'docs/' changes from c3b4f8410..a26d0e610 2020-07-20 22:19:42 +02:00
archetypes
config Squashed 'docs/' changes from 6c2195936..9be494de3 2020-05-31 12:43:23 +02:00
content Squashed 'docs/' changes from d3eb97a33..4895c29c5 2020-09-13 21:58:53 +02:00
data Squashed 'docs/' changes from c3b4f8410..a26d0e610 2020-07-20 22:19:42 +02:00
layouts Squashed 'docs/' changes from ac2c4a487..cfd74b57d 2020-07-07 06:58:43 +02:00
resources Squashed 'docs/' changes from c3b4f8410..a26d0e610 2020-07-20 22:19:42 +02:00
src
static Squashed 'docs/' changes from 54f0e8776..bd0e15bb6 2020-01-05 11:13:09 +01:00
.editorconfig
.gitignore
config.toml Squashed 'docs/' changes from 6c2195936..9be494de3 2020-05-31 12:43:23 +02:00
go.mod Squashed 'docs/' changes from cfd74b57d..c3b4f8410 2020-07-13 11:01:55 +02:00
go.sum Squashed 'docs/' changes from cfd74b57d..c3b4f8410 2020-07-13 11:01:55 +02:00
LICENSE.md
netlify.toml Squashed 'docs/' changes from a26d0e610..7297c1172 2020-08-14 18:31:01 +02:00
pull-theme.sh
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