Bjørn Erik Pedersen
28bd06265e
a26d0e610Add documentation to js.Build (#1175)439a22c3eUpdate index.md7a779b39aHugo 0.74.207cb5740cMerge branch 'temp742'abcea676creleaser: Add release notes to /docs for release of 0.74.2e0dcdbfeaRevert "Adding an issue link to the issue creation workflow (#1023)"21c7131f1Adding an issue link to the issue creation workflow (#1023)922afb18bUpdate index.mdb9512b192Update index.mdb7af5993cUpdate index.md816f864b6Release 0.74.11732f3461Merge branch 'temp741'd473f21c1releaser: Add release notes to /docs for release of 0.74.1bb234e9cdAdd release notes 0.74.05cb3166d4releaser: Add release notes to /docs for release of 0.74.07f35a3800Merge commit '823ce055ed3356da37e9ec4ac70446bdbbaa8de8'4b7054be5docs: Regenerate docs helper1d86f0aedMerge commit '6aa5c9117fd34644459ea9bcfb1b3f5010658d5d'068b2ab28Update formats.md doc for new allowed extensions.d71ed99d3Add support for inline partialsefe0e549cRework external asciidoctor integration git-subtree-dir: docs git-subtree-split:a26d0e6104
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