9e1dcefc5f
9be494de3 Clean up the markup config c3e123133 Remove JustComment bc1b02bc5 Add Smart to Anchor section 49e796409 Added where .RegularPagesRecursive was added a92296e31 Fixed the new-in shortcode in pages-vs-site-pages 051e1267c Documented .RegularPagesRecursive 5bcec88a3 Fix broken link in RSS templates page 3db79d433 Correct pull request link on migrations.md 55c347168 Release 0.71.1 11a4e36c3 Merge branch 'temp711' 481fc8ed6 releaser: Add release notes to /docs for release of 0.71.1 40ba83c26 Update site.md 382632b58 Use-modules: More help how to get started importing a theme (#1107) 06751d465 Addition of hugefastsearch to search options (#1118) 8346d3b18 Add example of how to set the permalinks option for pages in "root" ebb3b4f3a Refine highlight shortcode options 1075a172a Update index.md 7cc927ea6 Fix typo in v0.71.0 release notes 4121da273 Pull in latest theme version to get link hooks 4809be651 Document render-heading feature 2078a3bd1 Release 0.71.0 c09f6899e releaser: Add release notes to /docs for release of 0.71.0 90ffe2b50 Merge commit 'c9403cbceaaeff53ff4833561f4eefe1dc1a405e' bf3dd0837 Add math.Pow git-subtree-dir: docs git-subtree-split: 9be494de3ac79081be60e0f002db110cb96ec7a3 |
||
|---|---|---|
| .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