Bjørn Erik Pedersen
3886fc1fef
211a3c613Prepare the forestry.io article for release23995d6b4Add forestry.io to showcase3f177c94eFix some typos (found by codespell)dc26e0a5aClarify the default for site config files and multiple config filesc87c9c62eReview and update the Site config documentation for consistencya29edc50cFix the default value of rssLimit site config83f3c46b0Minor style fix4f860d1a2Typo capitalization fixes7851345c8Add docs about comments within templatesd129b4a28Make the recommendation to use partial over template consistent6cd260a41Update index.mda2787e1a4Add Let’s Encrypt showcase7e664f69eUpdate configuration.md8002120f1Update multilingual.md702b46a62Add documentation for the disableLanguages settingcb3d395deFix content type referenced33226924Update Page Kinds documentation8203f649dFix misformed markdown link19e99c957Add Section definition git-subtree-dir: docs git-subtree-split:211a3c6136
Hugo Docs
Documentation site for Hugo, the very fast and flexible static site generator built with love in GoLang.
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