28bd06265e
a26d0e610 Add documentation to js.Build (#1175) 439a22c3e Update index.md 7a779b39a Hugo 0.74.2 07cb5740c Merge branch 'temp742' abcea676c releaser: Add release notes to /docs for release of 0.74.2 e0dcdbfea Revert "Adding an issue link to the issue creation workflow (#1023)" 21c7131f1 Adding an issue link to the issue creation workflow (#1023) 922afb18b Update index.md b9512b192 Update index.md b7af5993c Update index.md 816f864b6 Release 0.74.1 1732f3461 Merge branch 'temp741' d473f21c1 releaser: Add release notes to /docs for release of 0.74.1 bb234e9cd Add release notes 0.74.0 5cb3166d4 releaser: Add release notes to /docs for release of 0.74.0 7f35a3800 Merge commit '823ce055ed3356da37e9ec4ac70446bdbbaa8de8' 4b7054be5 docs: Regenerate docs helper 1d86f0aed Merge commit '6aa5c9117fd34644459ea9bcfb1b3f5010658d5d' 068b2ab28 Update formats.md doc for new allowed extensions. d71ed99d3 Add support for inline partials efe0e549c Rework external asciidoctor integration git-subtree-dir: docs git-subtree-split: a26d0e610457c7942fd79e7abdd78021f9401796 |
||
|---|---|---|
| .github | ||
| _vendor | ||
| archetypes | ||
| config | ||
| content | ||
| data | ||
| layouts | ||
| resources | ||
| src | ||
| static | ||
| .editorconfig | ||
| .gitignore | ||
| config.toml | ||
| go.mod | ||
| go.sum | ||
| LICENSE.md | ||
| netlify.toml | ||
| pull-theme.sh | ||
| README.md | ||
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