9abd3043aAdd docs for shimming JS libraries6a1c8dcd7Update sitemap-template.md (#1245)37c397332Update frontends.mda0f86f6dfUpdate configuration.mdbb00cb2c1Update page-bundles.md773212de6Restructure and simplifyfcba7dddfSome minor clarifications of weight sorting759b967fcUpdate configuration-markup.md56708f0b7module import path remove slash at end59f4f4acdDoc: Fix typo in hugo commandfaacf2e97Clarify pagination documentation (#1208)d8eb60887netlify: Bump to 0.75.18cedf6231Merge branch 'temp751'188e2bf56releaser: Add release notes to /docs for release of 0.75.1c96d4b7a3Update index.md1a9d192f7Update index.md32731b916Update index.mda5bfa0c9aRestore the ... home pageb6850bf96Release 0.75.0d6e5e624freleaser: Add release notes to /docs for release of 0.75.08cd6b4f47typo: already -> already2cb2b22bbMerge commit '534ae9c57a902aea9ed6e62390dec11fa74b7122'e3525de23docs: Regen docs helperfd746dd83docs: Regenerate CLI docse20127980Add "hugo mod npm pack"8e82c7ce1markup/highlight: Add support to linkable line anchors on Chroma21e94911bmarkup/asciidocext: Fix AsciiDoc TOC with code50b8dace5modules: Add noVendor to module configd05b541femodules: Make ignoreVendor a glob patternc946082e7docs: Update replaceRE func149054341docs: Update replace funcd917567dfdocs: Update merge functionf1e093c92docs: Regen CLI docsc7bac967ddocs: Regen docs helper7a38f7a45Merge commit '7d7771b673e5949f554515a2c236b23192c765c8'1a5a7263amarkup/asciidoc: Add support for .TableOfContents git-subtree-dir: docs git-subtree-split:9abd3043a9
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