Bjørn Erik Pedersen
c494c37a45
20d77860bRemove the calibre image action58f53654dImprove image metadata formatting (#1067)c569f3657Update theme80e6d362eUpdate themed5806cca5Update themeefc5cb227Remove broken link on "where" page (#1058)443266076Comments Alternatives (#1036)9b480ebb7Fix typo1402365eeFix included typo in build-options.md3b5a76de1Update index.md1196c7695Update index.md1887ea1edUpdate index.mdd0666e74eHugo 0.68.3d514cfac9Merge branch 'temp683'49e57362breleaser: Add release notes to /docs for release of 0.68.3fa0ac3bf1Merge branch 'temp682'46993c209Release 0.68.24c8d6d242releaser: Add release notes to /docs for release of 0.68.29694f4d36Update index.md368a03754Update index.md0d997010cMerge branch 'temp681'24138a9cdreleaser: Add release notes to /docs for release of 0.68.17dd6cc788Update index.mdb6125b4a8Update build-options.mda2dead37aRelease 0.68.07cff41348Merge branch 'temp680'b3b37959creleaser: Add release notes to /docs for release of 0.68.00f98184b0Some minify configuration adjustments02219f787Add minify configefeea7be0Allow headless bundles to list pages via $page.Pages and $page.RegularPages7950d0ad1Mention `resources` folder in the "Directory structure" docs. git-subtree-dir: docs git-subtree-split:20d77860b2
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