Bjørn Erik Pedersen
5e078383a7
49809a03Merge commit '20a631b4964fc0ab9137cce1e41774cbc17de044'20a631b4Squashed 'themes/gohugoioTheme/' changes from b8202f539..dafc91ff18b58f565Re-generate CLI docs4653a724Add Netlify deployment badge2d6246bcRemove some deprecated site variablese6777153Improve Algolia Search Display Styling1570999fAdd missing "." in front of gitlab-ci.yaml exampleb922ae7dThis adds documentation to the new configDir/Environment logic from .53 (#729)7cff379fCorrectly escape multi-word taxonomy terms in example2dfeeda4fix typo by removing stray paren0870bd9aFix typo in `paginate` description91e8be85Fixes https://github.com/gohugoio/hugo/issues/5609c1db65ecMake the dummy URL more obviousb4589ff0Fix a linkb73dcb9aConsistently use "posts" as section name in examples7a56abbcFormat definitionsa9c6fd9bMinor clarification over the last commit5c86bdc8Add alternative instructions for Quick Start for non-git usersdafe7ee9Add Visual Studio Code plug-ins110ed19eUpdate HUGO_VERSION2abd031aUpdate page.mdb332f7b9Update page.mdf5a8c9d4Update static-files.md6d0c155cAdd note about relative protocol URLsa13751acTheme Warning: Remove note about unquoted URLs4c8f7d68Incorporate feedback6f2b9cf0Update Creating Themes Warning40d88d98Fix ToC example to use binary true/false4a11f3f1Fix typo2dbfc0a4Fix a typo in taxonomiesd63790efDo not mark UndocumentedFeature issues as staled7aff095Regenerate docs.json71c0826fUpdate transform.Unmarshal.md git-subtree-dir: docs git-subtree-split:49809a038b
2.6 KiB
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 these 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 examples, try to find short snippets that teaches people about the concept. If the example is also useful as-is (copy and paste), then great, but 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 an 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 is 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