README.md (2819B)
1 [](https://app.netlify.com/sites/gohugoio/deploys)
2 [](https://gohugo.io/contribute/documentation/)
3
4 # Hugo Docs
5
6 Documentation site for [Hugo](https://github.com/gohugoio/hugo), the very fast and flexible static site generator built with love in Go.
7
8 ## Contributing
9
10 We welcome contributions to Hugo of any kind including documentation, suggestions, bug reports, pull requests etc. Also check out our [contribution guide](https://gohugo.io/contribute/documentation/). We would love to hear from you.
11
12 Note that this repository contains solely the documentation for Hugo. For contributions that aren't documentation-related please refer to the [hugo](https://github.com/gohugoio/hugo) repository.
13
14 *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](https://github.com/gohugoio/hugo) repository.*
15
16 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:
17
18 * 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 …".
19 * 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.
20 * Hugo has users from all over the world, so easy to understand and [simple English](https://simple.wikipedia.org/wiki/Basic_English) is good.
21
22 ## Branches
23
24 * The `master` branch is where the site is automatically built from, and is the place to put changes relevant to the current Hugo version.
25 * 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/
26
27 ## Build
28
29 To view the documentation site locally, you need to clone this repository:
30
31 ```bash
32 git clone https://github.com/gohugoio/hugoDocs.git
33 ```
34
35 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](https://github.com/gohugoio/hugo).
36
37 Then to view the docs in your browser, run Hugo and open up the link:
38
39 ```bash
40 ▶ hugo server
41
42 Started building sites ...
43 .
44 .
45 Serving pages from memory
46 Web Server is available at http://localhost:1313/ (bind address 127.0.0.1)
47 Press Ctrl+C to stop
48 ```