Bjørn Erik Pedersen
2e711a28c7
af4b7ac5bRemove mention of Amber and Acec841e9207Exif docs corrections (#978)0f82420b8Change cache assets default example to 1 year676dc6e12Release 0.61.0a1d9fb18aMerge commit '79c5d7053486f540b6219e693d5590f2c4c3937a'1b9e675cdreleaser: Add release notes to /docs for release of 0.61.05b95cbc8aFixed suffixIsRemoved error in code samples (#975)59b2c245bFix Usage section in toc.md to consider Goldmark TOC settingsfd3828673Add link on how to configure TOC w/ Goldmarkea339f2d6Added external learning resources including Hugo In Action book.fab502d5dAdjust release notes269a025efRelease 0.60.16bff50beaMerge branch 'temp601'e15251c43releaser: Add release notes to /docs for release of 0.60.1690b864b9Update use-modules.md345ca8c36Update syntax-highlighting.mdbe64af9f5Update syntax-highlighting.mddf9dead83Update syntax-highlighting.md1c6e6d238Fix relnotes0ea6b2012Update homepagetweets.toml2c465625dUpdate index.md0025bba09Update index.md7417f1c05Update index.md9eeb8ce57Release 0.60.025a711023Merge branch 'temp60'0c4faab0ereleaser: Add release notes to /docs for release of 0.60.0779e5108eUpdate installing.md2ef1c386aMinor text improvements in README.md41ec5a19aReword sentence for clarity search.mdded74f098Add Goldmark as the new default markdown handlercb55cdbb0Update introduction.mdfcaad653aUpdate homepage.md7427a1fc5Update configuration.md8cc2c72catpl/collections: Allow dict to create nested structures4538c092cMerge commit 'efc0b1bb6c6564f54d596467dbc6a18cb206954e'90f908e7bSupport Go time format strings in permalinks git-subtree-dir: docs git-subtree-split:af4b7ac5b4
2.8 KiB
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