The world’s fastest framework for building websites.
Find a file
Bjørn Erik Pedersen 047c4188df Squashed 'docs/' changes from d9c8fc220..f9a5dc59b
f9a5dc59b Code Toggle block added to doc site final batch Templates  Variables 
4d4107968 Add eSolia as new sponsor
000fed94e Add missing closing tags for li in menu template example
f462b620f Clarify that local CSV files cannot be inside data dir
ae083641a Added hugo-search-index to list of search tools
e2b64d0b7 Remove extra link
2fb4c9af5 Release 0.38.2
59b1c9853 releaser: Prepare repository for 0.39-DEV
92f6a05ea releaser: Add release notes to /docs for release of 0.38.2
76244729e releaser: Bump versions for release of 0.38.2
0960c5fb3 Adjust gray color of tab vs pane in code-toggle.
8ae3aadd7 use code-toggle shortcode when relevant Content Management 
455b8b53b Update related.md
6e8d19090 Release 0.38.1
079ba044c releaser: Prepare repository for 0.39-DEV
6f23e6ec1 releaser: Add release notes to /docs for release of 0.38.1
c51692ceb releaser: Bump versions for release of 0.38.1
d37ea6a5e Update related.md
faa2707d0 Update index.md
9ce901dcb Add a forgotten language tag (go-html-template) for code
b05aaed14 Update where.md
4d4760819 Fix typo in code-toggle.md
c5a5250a1 Use the new go-html-template Chroma lexer
2de831f4b Add the full list of Chroma lexers
18114d4b4 Update Output Formats
b069d7f84 Release 0.38
caaa8355a releaser: Prepare repository for 0.39-DEV
e45b7cc9f releaser: Add release notes to /docs for release of 0.38
40f40906e releaser: Bump versions for release of 0.38
2d52e2e4e Merge commit 'ed8bf081fdbf336e026517b7e1b123c039014ab5'
1439f64a0 docs: Generate docshelper data
5b0edfd79 Add .Site.IsServer
fdb579ad1 Merge commit '0a23baa6a90901f772c234107c4f12c16c76f4aa'
7b71da1f8 hugolib: Add Reset method to delete key from Scratch
63a131664 docs: Add docs for lang.Merge
55cba056d Merge commit '3886fc1fef6ac19d58b9ba1bb642d0c6c9a54031'
6f301ebcc docs: Add docs on the new front matter configuration
7ba35ef56 Merge commit 'c0290655825e7bb36e13fb39f89d85b392cf1adc'
3d2cab754 releaser: Prepare repository for 0.38-DEV
095e888e1 releaser: Add release notes to /docs for release of 0.37.1
593fa0dcb releaser: Bump versions for release of 0.37.1
c18c1df54 releaser: Prepare repository for 0.38-DEV

git-subtree-dir: docs
git-subtree-split: f9a5dc59b77d15cc2c7534e10bcd90bcfeda7bb4
2018-04-16 07:43:59 +02:00
archetypes Squashed 'docs/' changes from 56c34962c..dce236ad1 2018-01-31 11:07:47 +01:00
content Squashed 'docs/' changes from d9c8fc220..f9a5dc59b 2018-04-16 07:43:59 +02:00
data Squashed 'docs/' changes from d9c8fc220..f9a5dc59b 2018-04-16 07:43:59 +02:00
layouts Squashed 'docs/' changes from d9c8fc220..f9a5dc59b 2018-04-16 07:43:59 +02:00
resources/_gen/images Squashed 'docs/' changes from d9c8fc220..f9a5dc59b 2018-04-16 07:43:59 +02:00
src Squashed 'docs/' changes from 2fc775dec..f97826a17 2018-02-10 12:51:31 +01:00
static Squashed 'docs/' changes from 715741f73..4e7e1815b 2018-03-11 20:39:20 +01:00
themes/gohugoioTheme Squashed 'docs/' changes from d9c8fc220..f9a5dc59b 2018-04-16 07:43:59 +02:00
.gitignore Squashed 'docs/' changes from 2fc775dec..f97826a17 2018-02-10 12:51:31 +01:00
.gitmodules Squashed 'docs/' content from commit f887bd7b 2017-08-10 17:18:22 +02:00
config.toml Squashed 'docs/' changes from d9c8fc220..f9a5dc59b 2018-04-16 07:43:59 +02:00
LICENSE.md Squashed 'docs/' content from commit f887bd7b 2017-08-10 17:18:22 +02:00
netlify.toml Squashed 'docs/' changes from d9c8fc220..f9a5dc59b 2018-04-16 07:43:59 +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 715741f73..4e7e1815b 2018-03-11 20:39:20 +01: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 GoLang.

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