The world’s fastest framework for building websites.
Go to file
Bjørn Erik Pedersen 230a495941 Squashed 'docs/' changes from b8b20e9a2..93f7baf80
93f7baf80 netlify: Hugo 0.92.2
ecd8a6b6b Merge branch 'tempv0.92.2'
ee04caf9f Fix validation of Page Kind in cascade target map
3fce03ed2 Remove the "check" command
70ad71b25 Fix typo (#1651)
dfd1dc570 Fix internal link (#1650)
b5e0e0d38 Update rotten Fedora package link
78276390a Add missing word in types.md (#1645)
45eb945f8 Remove hugo gen autocomplete
2f84d0896 netlify: Hugo 0.92.1
b55f5773b Update complement.md
7013ee43e Remove deprecated RSSLink from page variables
1c3fb6ed3 Remove deprecated page vars (#1638)
9bd0af3ab Update union.md
4576487a0 Update symdiff.md
58f1b26c7 Update starter-kits.md (#1521)
285356c1d Move inline partials section (#1635)
4d08625d2 Improve directions for editing Win 10 path env var (#1632)
41d9c7804 Update page content (#1629)
d05536cad Removed unpaired quote character (#1630)
3b0fdcd88 netlify: Bump to Hugo 0.92.0
cdb068346 docs: Regenerate docshelper
778503ca8 Merge commit 'a8e9fc699a6ff7d578f97a7c553ce844efad8fdb'
2d2401c91 docs: Add dependency table to maintainance page
6bc95c386 Add hugo.Deps
19d0b5e23 docs. Regen CLI docs
76a750d96 docs: Regenerate CLI docs
70156962a docs: Regenerate docshelper

git-subtree-dir: docs
git-subtree-split: 93f7baf80bd03176ad44701cd2452433d492ea0b
2022-02-14 12:58:42 +01:00
.github Squashed 'docs/' changes from 9be494de3..ac2c4a487 2020-06-16 14:18:51 +02:00
_vendor Squashed 'docs/' changes from 316cec249..4eb10c1a9 2021-12-13 21:04:12 +01:00
archetypes Squashed 'docs/' changes from 4eb10c1a9..b8b20e9a2 2022-01-12 08:15:10 +01:00
config Squashed 'docs/' changes from 4eb10c1a9..b8b20e9a2 2022-01-12 08:15:10 +01:00
content Squashed 'docs/' changes from b8b20e9a2..93f7baf80 2022-02-14 12:58:42 +01:00
data Squashed 'docs/' changes from b8b20e9a2..93f7baf80 2022-02-14 12:58:42 +01:00
layouts Squashed 'docs/' changes from b8b20e9a2..93f7baf80 2022-02-14 12:58:42 +01:00
resources Squashed 'docs/' changes from 316cec249..4eb10c1a9 2021-12-13 21:04:12 +01:00
src Squashed 'docs/' content from commit fdea5430f 2019-10-21 10:22:28 +02:00
static Squashed 'docs/' changes from 316cec249..4eb10c1a9 2021-12-13 21:04:12 +01:00
.editorconfig Squashed 'docs/' content from commit fdea5430f 2019-10-21 10:22:28 +02:00
.gitignore Squashed 'docs/' changes from 316cec249..4eb10c1a9 2021-12-13 21:04:12 +01:00
.markdownlint.yaml Squashed 'docs/' changes from 316cec249..4eb10c1a9 2021-12-13 21:04:12 +01:00
config.toml Squashed 'docs/' changes from 4eb10c1a9..b8b20e9a2 2022-01-12 08:15:10 +01:00
go.mod Squashed 'docs/' changes from 316cec249..4eb10c1a9 2021-12-13 21:04:12 +01:00
go.sum Squashed 'docs/' changes from 316cec249..4eb10c1a9 2021-12-13 21:04:12 +01: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 b8b20e9a2..93f7baf80 2022-02-14 12:58:42 +01: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