The world’s fastest framework for building websites.
Find a file
Bjørn Erik Pedersen 3a44bf182f Squashed 'docs/' changes from 81847981f..d88477eb3
d88477eb3 Fix some more redirect alias loops
209735670 Update features.md
d4ec6ef87 Remove redirect loop from functions/default
ce14da435 Fix the AlternativeOutputFormats/OutputFormats examples
f64a22469 Update cond.md
357a70a32 Remove redirect loop from templates/404
4ad7b01ba Remove some aliases that were causing infinite redirect loops
fd378e66a Fix alias redirect loop
ec3629f6f Revert "Set code background to white"
ffc56b880 Revert "Make inline code gray"
2a964e261 Make inline code gray
44069e09c Set code background to white
d39c790d0 Linked my own blog2md migration script
3e55267be Release 0.46
7b6cfdd8b releaser: Prepare repository for 0.47-DEV
d4cb54806 releaser: Add release notes to /docs for release of 0.46
6518ac7e7 releaser: Bump versions for release of 0.46
e54334d5c Merge commit '766085c2dc6fc95ac30fda2a9ebde2355fc12554'

git-subtree-dir: docs
git-subtree-split: d88477eb3a1959e2764d6025f5aa7a57a4a611e7
2018-08-08 13:54:28 +02:00
archetypes Squashed 'docs/' changes from 56c34962c..dce236ad1 2018-01-31 11:07:47 +01:00
content Squashed 'docs/' changes from 81847981f..d88477eb3 2018-08-08 13:54:28 +02:00
data Squashed 'docs/' changes from a4fa0d1d6..81847981f 2018-08-01 10:01:05 +02:00
layouts Squashed 'docs/' changes from 501c6e233..f59b3ab06 2018-07-06 17:52:13 +02:00
resources/_gen/images Squashed 'docs/' changes from 81847981f..d88477eb3 2018-08-08 13:54:28 +02:00
src Squashed 'docs/' changes from 2fc775dec..f97826a17 2018-02-10 12:51:31 +01:00
static Squashed 'docs/' changes from f59b3ab06..cfe89ecbc 2018-07-18 11:04:57 +02:00
themes/gohugoioTheme Squashed 'docs/' changes from a4fa0d1d6..81847981f 2018-08-01 10:01:05 +02:00
.gitignore Squashed 'docs/' changes from 2fc775dec..f97826a17 2018-02-10 12:51:31 +01:00
alias.txt Squashed 'docs/' changes from 81847981f..d88477eb3 2018-08-08 13:54:28 +02:00
config.toml Squashed 'docs/' changes from 81847981f..d88477eb3 2018-08-08 13:54:28 +02:00
LICENSE.md Squashed 'docs/' content from commit f887bd7b 2017-08-10 17:18:22 +02:00
netlify.toml Squashed 'docs/' changes from 81847981f..d88477eb3 2018-08-08 13:54:28 +02:00
pull-theme.sh Squashed 'docs/' content from commit f887bd7b 2017-08-10 17:18:22 +02:00
README.md Squashed 'docs/' changes from 0fd7b4169..501c6e233 2018-06-11 22:31:02 +02:00
requirements.txt Squashed 'docs/' content from commit f887bd7b 2017-08-10 17:18:22 +02:00

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 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 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