Bjørn Erik Pedersen
45e6fdb315
4eb10c1a9Set a sensible maxAge on the image cache2c37f4f89Update lists.md8690c018fUpdate introduction.md0458c3d88Update index.md150982f5eUpdate index.md50dc0b6b9Update multilingual.md648598090Configure image cache to use :cacheDir/images4dfb523c3Update introduction.mdb94d42e6fAdd text to social imagesd3253d2aaAdd resources/_gen/images/ to .gitignore8a56e1dfdDelete resources/_gen/images1521e79b6Update introduction.mdc7110a597Update introduction.mdf7c4d220fUpdate introduction.mdc14ecf1ffUpdate introduction.mdc4b388c20Fix shortcode in hugo-pipes/introduction (#1605)d9876bd68Update introduction.mda39a532d5Update introduction.mdfa8758122netlify: Hugo 0.90.150cc40570Update Contribute to Hugo Developmentfc98fc82cAdd .vscode dir to .gitignore (#1602)8f8bcdefcAdd frontmatter param to code-toggle shortcode (#1601)f3b432c7cAdd markdownlint configuration file (#1597)7ea3aea92netlify: Bump to 0.90.0e2b6f990bdocs: Regenerate docs helperc02259e33Merge commit '8d9511a08f14260cbfb73119e4afae50e5a9966d'2e3573899Add custom font support to images.Text3186e6458images: Text filter that draws text with the given options (#9239)424f219ebtpl/transform: Optional options for highlight func7993f17d0Implement XML data support1eb9d34cfMake resources.Get use a file cache for remote resources8a0fffd56Add remote support to resources.Get git-subtree-dir: docs git-subtree-split:4eb10c1a96
Hugo Docs
Documentation site for Hugo, the very fast and flexible static site generator built with love in Go.
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 the following criteria 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 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.
- Hugo has users from all over the world, so easy to understand and simple English is good.
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 are 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