Bjørn Erik Pedersen
d276e901b3
63386081cupdate cSpell config update15c76494bUpdate cSpell custom dictionary (#1694)34f3167b7Update image processing (#1625)7462cc798fix: pipes in sample code break table creation (#1686)48736447eUpdate anchorize.md2ff0bd10bnetlify: Hugo 0.95.00fc1d21b2Update configuration.md41855e372Fix #16828c663433eUpdate related.md7aa072eabnetlify: Hugo 0.94.21682c7ee7Update render-hooks.mdce1283cc4Move the Render Hooks doc to its own pagebbbbfbfc6Update configuration-markup.md92d91a316Update configuration-markup.md2e8068823Update configuration-markup.mdff2dbca60Update configuration-markup.md89d8e5d65Add code block documenatione993539f0Update shortcodes.mdc1b28dbfenetlify: Hugo 0.94.181b8c9b83Merge branch 'tempv0.94.1'4763b3d50docs: Regenerate CLI docsb18463971netlify: Bump to Hugo 0.94.04152ebc1dMerge branch 'tempv0.94.0'ba3a11ac2docs: Regenerate docshelpere64016d13docs: Regenerate docshelper29180e4d2add `.html` suffix to partial usage and references3213e00f2Docs tidy-up6cfcae4b7docs: Regenerate CLI docs8a6cd0b4ddocs: Regenerate docshelperb20ab262fMerge commit 'd706529720b3b2ccb99719ccd578062ca25a0cc2' git-subtree-dir: docs git-subtree-split:63386081c5
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