4e7e1815bFix some typosd23d8f5c4Remove 'fundamentals' category from function pages52fa65e15Mention Chroma as the preferred syntax highlighter64ca535dbMerge commit '8762aee8afe30bec6f1fbc9560749983dc44d60b'8762aee8aSquashed 'themes/gohugoioTheme/' changes from 396b859f..6f3a8bf503f0673a9Move the gopher to the theme320e268cdSpellinge45b640f7More layout lookup workfe0ad9d9dSync the YAML config menu example with TOML'sb9505fc70Remove template reference to ordinal numbers0fa2532d3Remove deprecated Hugoidx, add native hugo solution2152b907cFix a link in the last commit47614f416Manually specifying heading anchors in Markdown content9d6770d2aRelease notes 0.37.1e1eed8b27Remove some unused imagese960046f5releaser: Prepare repository for 0.38-DEV4fa83a4eereleaser: Add release notes to /docs for release of 0.37.146c879995releaser: Bump versions for release of 0.37.1fb3ac5a3ereleaser: Prepare repository for 0.38-DEV4870c8e7bUpdate archetypes.md232c0b578Merge commit '2b18014fd0aa99e9f1a5610ba875101351a90de3'2b18014fdSquashed 'themes/gohugoioTheme/' changes from fe71e360..396b859f62567e9aaAdd some "writing guidelines"7cfd530d2Revise the archetype docs5d4c3c03cUpdate data-templates.mde5fee3099Update page-bundles.mdca7f03c8dUpdate page-bundles.md2a7fdc269Fix typo 'vailable' to 'available' line 53999b75201LastMod should be Lastmod?099f46ca5Fix spacing in content-management/types.md6bcdc58efWord choice improvements20e8a21f6update rss linking docs7ef44d262Add some missing configuration entriesf1c7aa568Sort config list5cb8ceadeCreate a proper definition list for the configuration settings25dffe4acSend custom dimensions in GA55df01a34Fix broken gtag6c8772aadAdd site to GA confige63acb894Remove conflicting release note for 0.35f30083a23Add branch to GA config99caedb96Set the small-multiples to draft4a33c70abPolish the Small Multiples showcase7b2f1ea2eAdd small multiples showcasee78e96baeAdd new sponsorc42943041updated to new Forestry logoe07eda273Add OS env to faq414f0dbc6Release Hugo 0.3785f0cc324Merge branch 'temp37'1e6da9497Rebuild images75e97adfcreleaser: Add release notes to /docs for release of 0.3750b887cb0releaser: Bump versions for release of 0.377acf73ba3Merge commit '900b5f6cfe5a377ef369d26cd700201be4cf6b06'819d02c30Merge commit '374d184e6747678364fd61f5faf328ec9205eb6b'c7eacf018Fix typos in development contribution doc git-subtree-dir: docs git-subtree-split:4e7e1815b7
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