7c62d6ef16
a7e1e9be8 Clarify front matter date fields 69df4fc22 Clarify how to determine if .Inner is populated 9046bf424 Document strings.ContainsNonSpace 8dbe5df90 Fix indentation and broken image 48ad4124e Typo: functions/after.md d4c01b57b Link to detailed descriptions of canonfiyURLs and relativeURLs 4d9597302 Explain behaviour when appending to a slice containing other slices 69e24e44e Standardize right arrow usage 01b378726 Remove references to Google's Universal Analytics and the async template d415bae24 Use shared file to describe regex syntax e75dee6b8 snap: How to enable or revoke access to SSH keys feed2d1c0 Remove hasPrefix and hasSuffix in favor of namespaced versions 3c6d2cfe5 security: Use default execution settings 461b5fcaf netlify: Hugo 0.116.1 95fac27a5 configuration: correct cacheDir description cd9f1f929 configuration: Fix broken link 605394de4 netlify: Upgrade to Hugo 0.116.0 baf2a0f7b Merge branch 'tempv0.116.0' ee51a9323 Update requirements for building from source 40189956d Editor tools: Remove duplicate sentence fb0ff2621 docs: Regenerate CLI docs e8a5665c4 Update where.md 7bc5cf15d Update hosting instructions 018a04314 docs: Update where d33ae91cf docs: Update where function operators 9a108a664 docs: Rework the cacheDir documentation git-subtree-dir: docs git-subtree-split: a7e1e9be851b95e636ab5360e5151156b4f89044
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.
Edit the theme
If you want to do docs-related theme changes, the simplest way is to have both hugoDocs and gohugoioTheme cloned as sibling directories, and then run:
HUGO_MODULE_WORKSPACE=hugo.work hugo server --ignoreVendorPaths "**"
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