bd77f6e1c9
327003421 Update index.md cafdccc13 Hugo 0.86.1 467a89a02 Merge branch 'v0861' a22c37bc9 Merge branch 'release-0.86.1' 276da91a8 releaser: Add release notes to /docs for release of 0.86.1 198cdf8f0 tpl/lang: Add new localized versions of lang.FormatNumber etc. 93f986ecc Add timezone support for front matter dates without one b30b876bb Localize time.Format 950fdab90 Fix AddDate documentation 78d7b52b6 Document config.cascade fd1e1e4b7 Fix grammar and spelling (#1497) 05bf3aa32 Fix grammar / typos in news 32060a3b4 One more try f6e24ddfa PNG to JPG for the rel notes image 9ec5bdfad Update index.md 5f5d7f69d Release Hugo 0.86.0 2dd60bb71 releaser: Add release notes to /docs for release of 0.86.0 6445fb36c Merge commit '53a352795a69a9d4a373f50ec62138595948c6ea' cb57ca73a Simplify "active menu" logic for section menus git-subtree-dir: docs git-subtree-split: 327003421d8c07f9764aaaf644626805287fd30c |
||
---|---|---|
.github | ||
_vendor | ||
archetypes | ||
config | ||
content | ||
data | ||
layouts | ||
resources | ||
src | ||
static | ||
.editorconfig | ||
.gitignore | ||
config.toml | ||
go.mod | ||
go.sum | ||
hugo_stats.json | ||
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
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 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