github.com/rezahousseini/hugo@v0.32.3/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 GoLang.
     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  ## Branches
    14  
    15  * The `master` branch is where the site is automatically built from, and is the place to put changes relevant to the current Hugo version.
    16  * 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/
    17  
    18  ## Build
    19  
    20  To view the documentation site locally, you need to clone this repository:
    21  
    22  ```bash
    23  git clone https://github.com/gohugoio/hugoDocs.git
    24  ```
    25  
    26  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).
    27  
    28  Then to view the docs in your browser, run Hugo and open up the link:
    29  
    30  ```bash
    31  ▶ hugo server
    32  
    33  Started building sites ...
    34  .
    35  .
    36  Serving pages from memory
    37  Web Server is available at http://localhost:1313/ (bind address 127.0.0.1)
    38  Press Ctrl+C to stop
    39  ```