mirror of
https://github.com/gohugoio/hugo.git
synced 2024-07-04 08:11:55 +00:00
90ad804505
392668f4f Update theme 65d82c845 fix versions in GitHub Pages docs (#1815) 4e078a306 Create hosting-on-azure-static-web-apps.md (#1738) e24e25052 fix requirement typo (#1814) 0790eb173 fix broken link (#1813) f4a1b38c7 📄 Add more clarity on merging of config files (#1493) 2e82efff0 Install on Windows: Correct + augment (#1520) 4bffd076e Update frontends to add CloudCannon's CMS (#1509) 17eea3133 Update index.md to add resource (#1508) 5a5ac1d2f Add documentation for babel sourceMap (#1492) 899b7117c Update menu-templates.md 284dc4266 Include flexible translation in i18n.md f03421274 docs: Escaping Hugo/GO template code 4f0755683 Improve the documentation of imageConfig and the image resource 89aa723cc Clarify leaf bundle explanation and related FAQ 0c6b32bb9 Update starter-kits.md a68151b1b Update starter-kits.md 91b145384 Update starter-kits.md c8104b422 Update hosting-on-21yunbox.md 51ee7603b Update hosting-on-21yunbox.md d88314499 docs(en): add hosting on 21YunBox aab04f269 Update shortcode-templates.md to correct an error. ed48563aa Misc improvements 87dd24e1d Fix merge failure 0bcc6dca8 js.Build: Update docs to not allow boolean inputs for sourceMap e50a28fbc js.Build: Add SourceMap flag into js.Build opts which can turn on sourcemap 9695093a1 Fix Arch Linux installation command 3de773d7a Please remove hugo-elasticsearch plugin. 6510f0a5a release: Add some more ignore expressions to release notes config dc90b7517 typoe > typo (!) 3427c7436 Add hugoreleaser config 5a1f2d0dd Improves formatting of resources, assets sections (#1804) 03ba56fdd Remove Flesland Flis from Showcases 9f61dac7a Update slice.md 533e4e0cd Update theme 85e50325c Simplify writing 9b30e81b9 Typo fix and remove passive form 8974b6c53 dynamic-menu-configuration 1c5467329 netlify: Hugo 0.102.3 610a937b0 Remove Over from Showcase 99f5585bc netlify: Hugo v0.102.2 9f230ac1f netlify: Hugo v0.102.1 a6fc3f864 netlify: Bump to Hugo v0.102.0 3e9bc1a62 Merge branch 'tempv0.102.0' c08d6d898 Update en/templates/404.md with Firebase Hosting (#1796) 322b75f40 Update configuration.md 2fa6f0b94 404 template example: remove slash relURL arg 1195f168a Remove broken link (#1767) e0838e574 Update RenderString.md bee6adf71 Update page-resources.md 24e142f22 Remove duplicate word from cascade description 879fc3983 docs: Update the description of PostCSS config 2ffe539e3 fix: Use `=` instead of `:=` for variable reassignments (#1771) 7496b8f87 update 404 error for digitalocean docs c85caca4a Merge commit 'bdf935d66c1f02dfc942a30e9fc00519bba3aacb' c3888b63a docs: Regen docshelper 8a5942555 Merge commit '475f87f685439de0f907a9ffc29bfd1361eb1c59' 282007217 common: Add hugo.GoVersion 00b4b46da resources/page: Add :slugorfilename attribute git-subtree-dir: docs git-subtree-split: 392668f4f488d184b08b227028b01dbc02abd57a |
||
|---|---|---|
| .github | ||
| .vscode | ||
| _vendor | ||
| archetypes | ||
| config | ||
| content | ||
| data | ||
| layouts | ||
| resources | ||
| src | ||
| static | ||
| .cspell.json | ||
| .editorconfig | ||
| .gitignore | ||
| .markdownlint.yaml | ||
| config.toml | ||
| 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 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
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