Bjørn Erik Pedersen
7c62d6ef16
a7e1e9be8Clarify front matter date fields69df4fc22Clarify how to determine if .Inner is populated9046bf424Document strings.ContainsNonSpace8dbe5df90Fix indentation and broken image48ad4124eTypo: functions/after.mdd4c01b57bLink to detailed descriptions of canonfiyURLs and relativeURLs4d9597302Explain behaviour when appending to a slice containing other slices69e24e44eStandardize right arrow usage01b378726Remove references to Google's Universal Analytics and the async templated415bae24Use shared file to describe regex syntaxe75dee6b8snap: How to enable or revoke access to SSH keysfeed2d1c0Remove hasPrefix and hasSuffix in favor of namespaced versions3c6d2cfe5security: Use default execution settings461b5fcafnetlify: Hugo 0.116.195fac27a5configuration: correct cacheDir descriptioncd9f1f929configuration: Fix broken link605394de4netlify: Upgrade to Hugo 0.116.0baf2a0f7bMerge branch 'tempv0.116.0'ee51a9323Update requirements for building from source40189956dEditor tools: Remove duplicate sentencefb0ff2621docs: Regenerate CLI docse8a5665c4Update where.md7bc5cf15dUpdate hosting instructions018a04314docs: Update whered33ae91cfdocs: Update where function operators9a108a664docs: Rework the cacheDir documentation git-subtree-dir: docs git-subtree-split:a7e1e9be85
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