The world’s fastest framework for building websites.
Find a file
Bjørn Erik Pedersen 98293eaa15 Squashed 'docs/' changes from 501c6e233..f59b3ab06
f59b3ab06 Fix typo in template lookup order
1e5536d6c Mutlilingual: Document "content directory per language" system (#509)
849a86048 Update index.md
0c24d229b Polish Hugo Next
a4c9b0ee2 Polish
bbec2c76e Some more in birthday post
fc9681e21 More on contributors
09fe3ea31 Some more on the birthday post
8da357240 Content and images for the 5th birthday blog post
fb45bb8dc Add draft for anniversary blog post
4666d0a18 Release 0.42.2
9b74d286a Merge branch 'temp422'
354e7b66b releaser: Add release notes to /docs for release of 0.42.2
57a617f34 releaser: Bump versions for release of 0.42.2
ccc3ac1b8 Update errorf.md
35706c21a Update errorf.md
1c0f35fd1 Update errorf.md
b6170774b Add syntax highlighting gallery links for Chroma
f91d9da47 Update usage.md
c9a8f0190 Improve theme components documentation
3c4e39ddd Release 0.42.1
b45eb453f Merge branch 'temp421'
c74682a10 releaser: Prepare repository for 0.43-DEV
321e07fa5 releaser: Add release notes to /docs for release of 0.42.1
7154271e0 releaser: Bump versions for release of 0.42.1
360d8244f Add link to Privacy Config
1f2454247 Fix typo
a8f5f994e Fix typo
d9f3f078c Update simple variants documentation (#500)
f5cfd44e0 Release 0.42
fe604b321 releaser: Prepare repository for 0.43-DEV
c3e5b3ca0 releaser: Add release notes to /docs for release of 0.42
3174d1b37 releaser: Bump versions for release of 0.42
48cc2d51f docs: Update theme documentation
1922fb1a6 docs: Remove some files now moved
d7e4c453a Merge commit 'b239595af5a9fc1fc9a1ccc666c3ab06ccc32f04'
c40964c1b tplimpl: Remove speakerdeck shortcode
081f8a0f9 tpl/strings: strings.RuneCount
828ea5f15 tpl: Add strings.Repeat
a6b9f654a Add a BlackFriday option for rel="noreferrer" on external links
edb786516 Add a BlackFriday option for rel="nofollow" on external links
e4374971f releaser: Prepare repository for 0.42-DEV

git-subtree-dir: docs
git-subtree-split: f59b3ab06f282c26bce07263c8be6672cf8f7969
2018-07-06 17:52:13 +02:00
archetypes Squashed 'docs/' changes from 56c34962c..dce236ad1 2018-01-31 11:07:47 +01:00
content Squashed 'docs/' changes from 501c6e233..f59b3ab06 2018-07-06 17:52:13 +02:00
data Squashed 'docs/' changes from 501c6e233..f59b3ab06 2018-07-06 17:52:13 +02:00
layouts Squashed 'docs/' changes from 501c6e233..f59b3ab06 2018-07-06 17:52:13 +02:00
resources/_gen/images Squashed 'docs/' changes from 501c6e233..f59b3ab06 2018-07-06 17:52:13 +02:00
src Squashed 'docs/' changes from 2fc775dec..f97826a17 2018-02-10 12:51:31 +01:00
static Squashed 'docs/' changes from 896bad9f4..e161ea09d 2018-05-04 09:44:21 +02:00
themes/gohugoioTheme Squashed 'docs/' changes from 501c6e233..f59b3ab06 2018-07-06 17:52:13 +02:00
.gitignore Squashed 'docs/' changes from 2fc775dec..f97826a17 2018-02-10 12:51:31 +01:00
config.toml Squashed 'docs/' changes from 501c6e233..f59b3ab06 2018-07-06 17:52:13 +02:00
LICENSE.md
netlify.toml Squashed 'docs/' changes from 501c6e233..f59b3ab06 2018-07-06 17:52:13 +02:00
pull-theme.sh
README.md Squashed 'docs/' changes from 0fd7b4169..501c6e233 2018-06-11 22:31:02 +02:00
requirements.txt

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