mirror of
https://github.com/gohugoio/hugo.git
synced 2024-07-02 12:40:40 +00:00
7125ad401a
3b1a8579d Update theme b1f04fd47 params: Adjust the twitter handle 2c8ba029f Fix typo 4421e46ec Update Where.md 5f9fec6a5 Update glossary.md fb16945cf collections.Where - Clarify description of "collection" 4d6d7018b Update Include.md - improve return statement example 037151073 Update IncludeCached - improve return statement example b053fa09c Improve return types f7d615267 Describe minimum required Windows version e97762b2a Update front matter in math.Sub 9e4d03a79 Fix data.GetJSON examples 9029ee123 Update spellcheck GitHub Action c852fe421 Add version verification step to quick start guide 8fafca49c Correct front matter example b412fdf65 Fix closing tag in notes docs 9a64d9579 Add hreflang Tag to Translation Link example 2d2a82101 Fix inverted examples in Permalink and RelPermalink ff3e67e3f Correct spelling 3904b72e3 Fix documentation contribution steps enumeration 348fd3c02 Fix some typos in the content summaries page a5823459a Fix two links, one to bonsai.io and one to digital.gov c36978686 Fix typo 0ee3ff44f Vendor theme 6b0a9b75d Fix typo 44e4cb5c6 Fix typos 815071742 Update min Go version to build from source 192d14df5 Fix typo e4a18946e Miscellaneous corrections f12b7b74e netlify: Hugo 0.121.2 97dbc1ea1 Merge branch 'tempv0.121.2' dc1c0aeeb Add cache note to resources.Concat a8d1a6020 Correct return type eca22e97c Fix front matter 7de247a03 Correct return type 5058bc520 collections.Seq: Specify max slice size e24d81a4b Fix typo on FAQ page ff8cf5a88 Correct 'related' front matter values 88b21fae0 Adjust deprecation handling f7e19a25b Update terminology on shortcode templates page 01e10942a Adjust formatting 6ed2e19c2 tpl/math: Add math.Rand template function b494a8d8d Update js.md 6d78035f4 Add interval description to glossary (#2378) f9b612b64 Templates Lookup Order: Add missing parenthesis 741ab1bb2 Show vendorClosest in module default config eb8cb878f Fix Babel headings cdcdfc8e8 Change project name in Codeowners example f31fe0d63 Update link to image filters 9dee1ee0e Update Solus installation instructions 716636fee Add TOC to collections.Sort f7c64143c Update collections.Sort 4b8f6b991 Add id attributes to Scratch and Store methods 2a1adea79 Add id attributes to GitInfo, File, and Resources methods b12d9cb8f Add Alpine Linux installation instructions dfbebeec7 Change writeStats to buildStats 175b8aac8 resources/images: Create AutoOrient image filter ba8e05c31 Update img shortcode 7fc15a6cc Fix default value of pluralizeListTitles a0be4fd8a Add Comentario to available comment engines 71aa7d8ab Update GitInfo.md 348441491 EXIF: describe applicable image types 743497eda Disable TOC for lang.Translate b3b1df75d Describe lang.Translate fallback behavior a6d9c362c Categorize CLI commands to improve search results 08cc2da4b Document canonical config for enabling inline shortcodes 8945be9c6 Update description of the humanize ordinal conversion b8b4ccb6f Fix grammatical error f53f9f936 Fix description of strings.HasSuffix cdbe19b5b Update Params.md e00c4eea2 Reformat site config descriptions 6f50c0755 Enumerate root configuration keys 1f2e7b9b2 Use canonical key when documenting menu configs 7d5a13d8d Update images.Text filter 315d2f8c3 Add math.Counter example to warnf 8ed9cdaa9 Miscellaneous edits 2bda491eb Fix front matter example 5c5bbbe3a netlify: Bump to Hugo 0.121.1 ed08f5943 Update Gentoo installation instructions e4eb48457 Miscellaneous edits 8c3700d12 netlify: Bump to Hugo 0.121.0 1bb5a377f Merge branch 'tempv0.121.0' 8cba89504 Improve where function 0dfc00b0f docs: Regen docshelper 028076a66 Fix link to Gentoo package 52d2db4ff Fix typo 120025c19 Improve Gentooo installation instructions 0c31a4b45 Update GitHub hosting workflow example dee99c36a Defend against missing aliases in quick-reference shortcode d305278f1 Add Gentoo installation instructions be98a37e1 docs: Adjust last merge from docs repository a703dab53 docs: Regen docs helper 2e9c3532f Merge commit '35dec7c96f7ee3eb17dd444f7067f0c776fb56ae' f57fdb44b deps: Update github.com/tdewolff/minify/v2 v2.20.7 => v2.20.8 50cad5e38 tpl/transform: Add transform.XMLEscape template function git-subtree-dir: docs git-subtree-split: 3b1a8579d2e032c1aab8a74d4cf63849ba11e7a8 |
||
|---|---|---|
| .github | ||
| .vscode | ||
| _vendor | ||
| archetypes | ||
| assets/images | ||
| config | ||
| content/en | ||
| data | ||
| src | ||
| static | ||
| .cspell.json | ||
| .editorconfig | ||
| .gitignore | ||
| .markdownlint.yaml | ||
| .markdownlintignore | ||
| .textlintignore | ||
| go.mod | ||
| go.sum | ||
| hugo.toml | ||
| hugo.work | ||
| hugo_stats.json | ||
| hugoreleaser.toml | ||
| LICENSE.md | ||
| netlify.toml | ||
| pull-theme.sh | ||
| README.md | ||
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 codebase 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.
Edit the theme
If you want to do docs-related theme changes, the simplest way is to have both hugoDocs and gohugoioTheme cloned as sibling directories, and then run:
HUGO_MODULE_WORKSPACE=hugo.work hugo server --ignoreVendorPaths "**"
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