c494c37a45
20d77860b Remove the calibre image action 58f53654d Improve image metadata formatting (#1067) c569f3657 Update theme 80e6d362e Update theme d5806cca5 Update theme efc5cb227 Remove broken link on "where" page (#1058) 443266076 Comments Alternatives (#1036) 9b480ebb7 Fix typo 1402365ee Fix included typo in build-options.md 3b5a76de1 Update index.md 1196c7695 Update index.md 1887ea1ed Update index.md d0666e74e Hugo 0.68.3 d514cfac9 Merge branch 'temp683' 49e57362b releaser: Add release notes to /docs for release of 0.68.3 fa0ac3bf1 Merge branch 'temp682' 46993c209 Release 0.68.2 4c8d6d242 releaser: Add release notes to /docs for release of 0.68.2 9694f4d36 Update index.md 368a03754 Update index.md 0d997010c Merge branch 'temp681' 24138a9cd releaser: Add release notes to /docs for release of 0.68.1 7dd6cc788 Update index.md b6125b4a8 Update build-options.md a2dead37a Release 0.68.0 7cff41348 Merge branch 'temp680' b3b37959c releaser: Add release notes to /docs for release of 0.68.0 0f98184b0 Some minify configuration adjustments 02219f787 Add minify config efeea7be0 Allow headless bundles to list pages via $page.Pages and $page.RegularPages 7950d0ad1 Mention `resources` folder in the "Directory structure" docs. git-subtree-dir: docs git-subtree-split: 20d77860b2a992b4917af75a657419b19baafa43 |
||
|---|---|---|
| .github | ||
| _vendor | ||
| archetypes | ||
| config | ||
| content | ||
| data | ||
| layouts | ||
| resources | ||
| src | ||
| static | ||
| .editorconfig | ||
| .gitignore | ||
| config.toml | ||
| go.mod | ||
| go.sum | ||
| 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