Bjørn Erik Pedersen
77b976dd92
686c7b6ebci(Netlify): specify `HUGO_VERSION` environment variable onceda99a356ffix: change heading levele57da3f00Update taxonomy methods746172490Update description of rendered breadcrumb navigation6bc52fd40Clarify termdab07dcb0Fix typoe50fa452aFix typo6c1ea83c2Update template overview pagea5dc97845Clarify the append functiona135e52a0Update GitHub hosting instructionsa51bf9f4fUpdate sections pageed35fc6c4Update archetypes and glossary1a4522b3eFormat examplesa70f20094Use "hugo new content" to create content673846ff9Remove commentb7febf0c5Fix link6f6fe2133Miscellaneous edits99227dd18Remove lookup order table from output formats pagebc8870657tools/editors: Add Prettier Plugin for Go Templates157b169ebUpdate docs.yaml1c8f514e0Update cond functione5f1f8113Add assumptions to taxonomy and term template lookup order examples475b406e2Update postprocess2d6cb8dfcglossary: Update content type03b514bacAdd descriptions to template lookup order example sections06678f919glossary: Fix broken link4cd505612Simplify news listingfadb980dbUpdate glossary of terms491bacd78Change order of example sections for template lookup order04b8f39ecCreate glossary of terms12e896bc0Remove reference to asciidoctor-rouge extension055f7bb37Insert missing words8cd6ac387Miscellaneous edits2cbe17f41Update configuration.md529615373Update data-templates.md853154e65Update theme45f08627aresources.getRemote: Fix definition list29a51dac1Update docshelper3bdfe88c6Remove link to gitter from site footercacd0e461Use "map" instead of "dictionary"704dd5da6Document the transform.Remarshal template functione8d744951Populate news section via GitHub releases API3ff1118c7Replace docs.json with docs.yaml7726bbcacUse docs.json to generate default config throughout the site57dca93dfUse docs.json to generate default config for related content74d5082c7Add some .RenderShortcodes docscf5ab5062netlify: Hugo 0.117.0420f7aa69Add all config to docshelper.json git-subtree-dir: docs git-subtree-split:686c7b6eb1
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