da16527896
4c1309cdf Fix broken link to front matter page (#1923) 8181fff20 Add footnote to Quick Start guide for Win users (#1922) 4fd934f61 Fix abslangurl.md (#1919) bf2c45617 Quick start guide: fix broken links (#1915) 201b568df Update theme 874db199d Hide the news stripe on front page for now aaf59e3e2 netlify: Hugo 0.107.0 79654c301 Merge branch 'tempv107' 8345e0347 docs: Regen docs helper b5b4f15f9 Add assets directory to directory structure diagram (#1917) 76dd3a82a Follow-up: improve function signatures (#1914) (#1916) 656dc72ba Improving function signatures (#1914) b715e8407 Explain how to create multilingual content (#1912) 8500ee417 Fix typo in Quick Start guide ce60bb572 Add docu for undocumented functions (#1907) 372bf5e88 Improve Quick Start tutorial 71e81ec5f Remove asciicast from site 1e56c653f Update hosting-on-cloudflare-pages.md (#1903) 1686f60b1 Adding documentation page for function 'strings.FirstUpper' (#1901) d533f7c9c Fixing typos (#1900) 2563eee45 Update multilingual.md (#1899) 2173ed799 Update theme 5591b8875 Update urls.md (#1897) 4a88890b5 netlify: Hugo 0.106.0 512879fdd docs: Regen CLI docs f74b1d87d docs: Regenerate docs helper 9feacb48f Merge commit '00c4484c7092181729f6f470805bc7d72e8ad17b' git-subtree-dir: docs git-subtree-split: 4c1309cdfe9858434684352f9d544bf0c5c9d646 |
||
|---|---|---|
| .github | ||
| .vscode | ||
| _vendor | ||
| archetypes | ||
| config | ||
| content | ||
| data | ||
| layouts | ||
| resources | ||
| src | ||
| static | ||
| .cspell.json | ||
| .editorconfig | ||
| .gitignore | ||
| .markdownlint.yaml | ||
| .markdownlintignore | ||
| .textlintignore | ||
| go.mod | ||
| go.sum | ||
| hugo_stats.json | ||
| hugoreleaser.toml | ||
| LICENSE.md | ||
| netlify.toml | ||
| pull-theme.sh | ||
| README.md | ||
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 codebase 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
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 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