You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Wooseop Kim 835ddd9c23 Fix broken link 4 days ago
.github Remove image-actions 2 weeks ago
_vendor Update theme 3 months ago
archetypes Add showcase archetype folder 1 year ago
config Add Goldmark as the new default markdown handler 1 month ago
content Fix broken link 4 days ago
data docs: Regenerate docshelper 2 weeks ago
layouts Add Goldmark as the new default markdown handler 1 month ago
resources Release 0.62.0 4 weeks ago
src Add Showcase to Home page and internal pages 1 year ago
static Optimised images with calibre/image-actions 2 weeks ago
.editorconfig Create .editorconfig 5 months ago
.gitignore Add trace.out to .gitignore 9 months ago
LICENSE.md Change the license to Apache 2.0 4 years ago
README.md Minor text improvements in README.md 1 month ago
config.toml Add Goldmark as the new default markdown handler 1 month ago
go.mod Update theme 3 months ago
go.sum Update theme 3 months ago
netlify.toml Release 0.62.2 2 weeks ago
pull-theme.sh Add script to pull theme changes 2 years ago

README.md

Netlify Status PRs Welcome

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 master branch is where the site is automatically built from, and is the place to put changes relevant to the current Hugo version.
  • The next branch 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