The world’s fastest framework for building websites.
Find a file
Bjørn Erik Pedersen e48ffb7635 Squashed 'docs/' changes from 1de7a358c..ef9c4913c
ef9c4913c Clean up and removal of outdated examples
46122c9aa add godot tutorials to showcase
06d1d1ea2 Update scss-sass.md
1fc63c100 Spelling fix in 0.79.1 release notes
ad2f50e3d Update plainwords description (#1296)
33021d451 Update substr examples (#1304)
6b1cc59bb Release 0.80.0
521db8c6d Merge branch 'tempv0.80.0'
58626c2b3 releaser: Add release notes to /docs for release of 0.80.0
f81d118af dartsass: Dart Sass only supports `expanded` and `compressed`
7da6f54be Add Dart Sass support
b1f2661bb Replace jsconfig.js with jsconfig.json
38de0c1a4 Update index.md
223ceae80 Update index.md
f7ac0e59d Release v0.79.1
2d4583d43 Merge branch 'temp791-2'
1d34e609b releaser: Add release notes to /docs for release of 0.79.1
e26769988 Merge branch 'temp791'
75694d904 Fix Resource.ResourceType so it always returns MIME's main type
0f65d7783 Typo s/adds/add (#1298)
0b896b2c0 images: Add images.Overlay filter
0d4257dcd Clarify documentation on shimming
fcf601ddf Update index.html
6bf9bc1c1 Update index.html
1ce76bf3a Update index.html
e7d976eec Update index.html
db2996e64 Update index.html
245e5bfc9 news: Add post about Apple M1
3ad4115ed tpl: Add title parameter to YouTube shortcode
76ed976f8 Added two useful extensions to the list (#1243)
e5a30dd11 Update related.md
25cf8f48b Improve substr examples
e16e57e9a Update path.Split.md
2749b88fd Update path.Split.md
d76cad3ff Release 0.79.0
f5ccfbe98 releaser: Add release notes to /docs for release of 0.79.0
ebf1b87b0 Merge commit '9f1265fde4b9ef186148337c99f08601633b6056'
1f1e8f39c Allow setting the delimiter used for setting config via OS env, e.g. HUGO_
e9b1414dd deps: Update to github.com/evanw/esbuild 0.8.11 to 0.8.14
0f76cf66c docs: Regen docshelper
1ada5d47e Add menu params
1c120aef0 Revert "docs: Regenerate docshelper"
7b60b5624 docs: Regenerate docshelper

git-subtree-dir: docs
git-subtree-split: ef9c4913cdcf95d62ec12d872f412f97e55a55ad
2021-01-20 12:47:49 +01: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 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 1de7a358c..ef9c4913c 2021-01-20 12:47:49 +01:00
data Squashed 'docs/' changes from 1de7a358c..ef9c4913c 2021-01-20 12:47:49 +01:00
layouts Squashed 'docs/' changes from ac2c4a487..cfd74b57d 2020-07-07 06:58:43 +02:00
resources Squashed 'docs/' changes from 1de7a358c..ef9c4913c 2021-01-20 12:47:49 +01: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/' content from commit fdea5430f 2019-10-21 10:22:28 +02:00
config.toml Squashed 'docs/' changes from 57c1d1a67..1de7a358c 2020-11-27 09:26:24 +01: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 Squashed 'docs/' content from commit fdea5430f 2019-10-21 10:22:28 +02:00
netlify.toml Squashed 'docs/' changes from 1de7a358c..ef9c4913c 2021-01-20 12:47:49 +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