Bjørn Erik Pedersen
0a23baa6a9
3068989b9Merge commit '7ae9cf2ccb3eecc1ff50f686925249d01cf37c6c'7ae9cf2ccSquashed 'themes/gohugoioTheme/' changes from d7a475e7..a1768ebbb55157faeRevert "Anchorify headings up to h4"b63dd5566Anchorify headings up to h4edfe36a19Test out trac as highlighter style98dc8d269Update multilingual.mda6e4d92c0Update multilingual.md86a90edf9Fix typo 'If will' to 'It will' line 416b626fac6Add a tip for testing custom 404.html on hugo server6bfc17cfcUpdate few links to now point to gohugoio organization reposf66bad971Remove unintended alias3bc56e9ecFix shortcode name in example: image -> img251142388Fix broken link27245af6aFix the minimum required git version for GH Pages flowaefc87b4dFix link in Forestry showcase489ec5ea0Squashed 'themes/gohugoioTheme/' changes from 6f3a8bf5..d7a475e7308a616fdMerge commit '489ec5ea03799fa092d891838c1655e60b34f337'a80859814Adjust showcase description git-subtree-dir: docs git-subtree-split:3068989b9c
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