8b73644d81
0f2bf195e Adjust shortcodes for 0.55 48c577121 Fix deprecation warnings ed95a341a Update index.md e4bc8981f Release 0.55.0 25acacb91 Merge branch 'temp55' b240e321a releaser: Add release notes to /docs for release of 0.55.0 86a190c92 docs: Add information about summary front matter variable 9d94f4340 integrity: Add support for sha384 dd3fe9f92 Add HUGO_NUMWORKERMULTIPLIER 968372d86 Add trace.out to .gitignore 660772713 Add the Fireship images to cache 41a3e19cb hugolib: Allow page-relative aliases 4497e4b12 Update faq.md b0ee3dccc output: Add missing JSON tag 173dac0b7 docs: Regenerate docshelper data e30473062 docs: Regenerate CLI docs 8cb775be2 Merge commit 'c2037f0c9a3a35b9db9c404f6b5f94ec8b690a53' 5bc64bf44 Make Page an interface 371ff6c12 Add skipHTML option to blackfriday config git-subtree-dir: docs git-subtree-split: 0f2bf195ef549013cc843199fb50317b0d1a5e85 |
||
|---|---|---|
| .github | ||
| archetypes | ||
| config | ||
| content | ||
| data | ||
| layouts | ||
| resources | ||
| src | ||
| static | ||
| themes/gohugoioTheme | ||
| .gitignore | ||
| config.toml | ||
| LICENSE.md | ||
| netlify.toml | ||
| pull-theme.sh | ||
| README.md | ||
| requirements.txt | ||
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 these 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 examples, try to find short snippets that teaches people about the concept. If the example is also useful as-is (copy and paste), then great, but 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 an easy to understand and simple English is good.
Branches
- The
masterbranch is where the site is automatically built from, and is the place to put changes relevant to the current Hugo version. - The
nextbranch is where we store changes that is 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