Bjørn Erik Pedersen
35febb2e2a
540aeddc7Small fixes for Open Graph internal template47bbb3fd7Bump lodash.template from 4.4.0 to 4.5.0 in /themes/gohugoioTheme64c1cc3dbUpdate title.md36c27be37Update configuration.md4627cfe9aadded commento.io to the list341d9d945Fix link to font assets4a6876decSmall typo fix in configuration.md736d6ddd7Add bypasscensorship.org showcase.de7ab636bUse actual width in image processing examples6c88ab2daUpdate directory-structure.md88f559e81Fix spelling mistakes7bd427141Rephrase four points from Hosting on Github docsbce1b1832Fix typos for absLangURL and relLangURL functionsabab57335Update directory-structure.mda6716f2edFix metadata list5ef61d912Fix typod9e467b8bActuall show how to generate pages in quickstart0aadc92e7Update link to issue theme submissionb1902faaaRemove incorrect note about Hugo snap --classic use.d451e7362Update documentation on page variablesab2233c39Update publish_to_ghpages.sh7c120346bFix typo in syntax highlighting page.f01dc555dCorrect some typosbe825ade9Videos plural produces og:videobc962fbdfUpdated installing.md file to include linuxbrew installation08c9f8fc8Mention 1 MB file size limit in readFile doc7145e29e2Fixes bad URL in menus.md for .hasChildren * part of issue #8140edbd59c4add warning about .Hugo variable being deprecated77f74ced5fix: typo in output-formats.mdf71b67f34Correct typo "RFC339" to "RFC1123Z" (#837)424c0207abaseurl -> baseURLf4e24a03eRender launched; no invite code needed37e1101d3Add Render hosting guide01d0a6481Bump js-yaml from 3.12.0 to 3.13.1 in /themes/gohugoioThemeedb7b36b0Link site hierarchy schema to larger versionaf72acda0Fixes typo in fingerprint.md0a738467bAdding required XML tag to sample templates52211f656Remove note that XML declaration is not neededa39b9ac87Adding required XML tag to sample templates1a44d8a50Add configuration information for Azure5b7c6b5a1remove google plus5a64301baHTTPS link to yaml.org/spec/ git-subtree-dir: docs git-subtree-split:540aeddc79
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 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