i-give-up
ee81931a41
The use of `---` and `...` delimiters in the YAML examples seem to suggest that those delimiters are necessary in a .yaml/.yml file when in fact they are optional. Also, it seems to be common practice to *not* use `---` and `...` in .yaml/.yml files. Similarly, it's less common to use `+++` in .toml files. The examples on TOML's Github repo don't use it, and Hugo-generated .toml files don't use it either. This commit removes the delimiters mentioned above to conform with the more common styles. Additionally this modifies the example for shortcut to find configuration option - add `cd` to make it clear that user has to change to the hugo site's directory first - separate the command and the output of the command
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.
Branches
- The
masterbranch is where the site is automatically built from, and is the place to put changes relevant to the current Hugo version. - The
nextbranch 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