github.com/shohhei1126/hugo@v0.42.2-0.20180623210752-3d5928889ad7/docs/README.md (about)

     1  # Hugo Docs
     2  
     3  Documentation site for [Hugo](https://github.com/gohugoio/hugo), the very fast and flexible static site generator built with love in Go.
     4  
     5  ## Contributing
     6  
     7  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. 
     8  
     9  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. 
    10  
    11  *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.*
    12  
    13  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:
    14  
    15  * 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 …".
    16  * 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.
    17  * Hugo has users from all over the world, so an easy to understand and [simple English](https://simple.wikipedia.org/wiki/Basic_English) is good.
    18  
    19  ## Branches
    20  
    21  * The `master` branch is where the site is automatically built from, and is the place to put changes relevant to the current Hugo version.
    22  * 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/
    23  
    24  ## Build
    25  
    26  To view the documentation site locally, you need to clone this repository:
    27  
    28  ```bash
    29  git clone https://github.com/gohugoio/hugoDocs.git
    30  ```
    31  
    32  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).
    33  
    34  Then to view the docs in your browser, run Hugo and open up the link:
    35  
    36  ```bash
    37  ▶ hugo server
    38  
    39  Started building sites ...
    40  .
    41  .
    42  Serving pages from memory
    43  Web Server is available at http://localhost:1313/ (bind address 127.0.0.1)
    44  Press Ctrl+C to stop
    45  ```