Bjørn Erik Pedersen
d706529720
a393f4cf4Add a Spellcheck GitHub Action and config8b6b1c381netlify: Bump to Hugo 0.93.384515c183Delete deployment-with-nanobox.mddd45f9899Fix typos in docse69de81a9Update build-options.md7745b7891netlify: Hubo 0.93.2037d63364Clarify GitHub Pages Branches94660c34badd missing %s325de15e2fix link to latest release note since the release notes were moved to GitHub: https://gohugo.io/news/no-more-releasenotes-here/dbff41d01Update introduction.md0ecd627f7netlify: Hugo 0.93.1a74e16582Update diagrams.md33e310956Add Goat example to test stylingfa0100a5bUpdate diagrams.md64ac75367Adjust diagram docsf1d600044Update theme95bedff1anetlify: Bump to Hugo 0.93.0849a8437fMerge commit 'c1398b91a9f4c67876b31feb67516b252e654d3c'c0c60c43cdocs: Regenerate docs helper2c63fe518cod: Regen CLI docsf33ba4e5aCodeblockContext method renames979b47968Move the Goat template to the correct place2df37e9e8Add Markdown diagrams and render hooks for code blocksbd8037d43Allow images to be cropped without being resized8b2af4b49modules: Add modules.Workspace config for Go 1.1846b99dea1Add --printUnusedTemplates1285302c9commands: Rename --i18n-warnings to printI18nWarningsdea2242c6commands: Rename --path-warnings, --print-men to --printPathWarnings, --printMemoryUsagedb782ea46deps: Update github.com/alecthomas/chroma v0.9.4 => v0.10.0 git-subtree-dir: docs git-subtree-split:a393f4cf43
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