785e375f5 Change 'my-another-post' to 'my-other-post' ba9a69d25 Update reflect.IsSlice.md 806344258 Update reflect.IsMap.md 757c0dafa Update index.md d3f20a2d5 Update index.md 9952e72a0 Formatting 70458ccf2 Formatting 7e0dd3969 Merge branch 'config-dir' 06a5c11fc Release 0.53 01c00229f releaser: Prepare repository for 0.54-DEV 29b223f78 releaser: Add release notes to /docs for release of 0.53 4f61d1194 releaser: Bump versions for release of 0.53 320a0ac68 Refactor config below /config ec16b611e docs: Adjust CSV example cecf97dfc Rename CSV option from comma to delimiter 18d06df58 docs: Document transform.Unmarshal fdace78b5 docs: Regenerate CLI docs b8f84ac59 hugolib: Add .Name as a shortcode variable 6612dd1b8 Merge commit '5a83bf314f4c0ce1d61341e0a1df21c9998e8154' 9b211089f docs: Regenerate CLI docs 9af46af3c Merge commit 'eb16165694f868d73e57b6aed5c26ba5e98229de' 12f46f356 tpl: Add reflect namespace git-subtree-dir: docs git-subtree-split: 785e375f577394c6f782ef51796e2efe88d52cbb |
||
---|---|---|
.github | ||
archetypes | ||
config | ||
content | ||
data | ||
layouts | ||
resources | ||
src | ||
static | ||
themes/gohugoioTheme | ||
.gitignore | ||
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
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 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