Bjørn Erik Pedersen
7d7771b673
d3eb97a33Document .IsSection page variablea068bcf5cAce and Amber support was removed with #66095cd9ca4b2Mention MacPorts also on the Installing page (#1215)0ae8f5c19Add instructions for using Macportsd50aba8f0Revise ref and relref function pagesa17e25d6fUpdate quick-start.md: move notice about drafts upcf87a5da2Update macOS tarball installation instructions (#1203)2e701f8f3Corrected the url for index function link736bd59e0Clarify treatment of zero weights (#1207)42a19f479Fix example of output from urlize function34f8de26dRevise content-management/cross-references252435a95Rewrite Translation of Stringsf0882bc14Remove note that has been outdated by v0.71.0dfe28ceb5Improve mounts module config58029627dFix erroneous example code piping to if git-subtree-dir: docs git-subtree-split:d3eb97a332
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