diff options
74 files changed, 112 insertions, 156 deletions
diff --git a/docs/.github/SUPPORT.md b/docs/.github/SUPPORT.md new file mode 100644 index 000000000..cc9de09ff --- /dev/null +++ b/docs/.github/SUPPORT.md @@ -0,0 +1,3 @@ +### Asking Support Questions + +We have an active [discussion forum](https://discourse.gohugo.io) where users and developers can ask questions. Please don't use the GitHub issue tracker to ask questions. diff --git a/docs/content/en/about/benefits.md b/docs/content/en/about/benefits.md index 16d43e48f..020e58981 100644 --- a/docs/content/en/about/benefits.md +++ b/docs/content/en/about/benefits.md @@ -28,7 +28,7 @@ This has many benefits. The most noticeable is performance. HTTP servers are *ve ## More on Static Site Generators * ["An Introduction to Static Site Generators", David Walsh][] -* ["Hugo vs. Wordpress page load speed comparison: Hugo leaves WordPress in its dust", GettingThingsTech][hugovwordpress] +* ["Hugo vs. WordPress page load speed comparison: Hugo leaves WordPress in its dust", GettingThingsTech][hugovwordpress] * ["Static Site Generators", O'Reilly][] * [StaticGen: Top Open-Source Static Site Generators (GitHub Stars)][] * ["Top 10 Static Website Generators", Netlify blog][] diff --git a/docs/content/en/about/features.md b/docs/content/en/about/features.md index a1e741ac0..9c8fac4f4 100644 --- a/docs/content/en/about/features.md +++ b/docs/content/en/about/features.md @@ -44,7 +44,7 @@ toc: true * Automatic and user defined [content summaries][] * [Shortcodes][] to enable rich content inside of Markdown * ["Minutes to Read"][pagevars] functionality -* ["Wordcount"][pagevars] functionality +* ["WordCount"][pagevars] functionality ## Additional Features diff --git a/docs/content/en/about/hugo-and-gdpr.md b/docs/content/en/about/hugo-and-gdpr.md index e193e1838..7c1c9bed4 100644 --- a/docs/content/en/about/hugo-and-gdpr.md +++ b/docs/content/en/about/hugo-and-gdpr.md @@ -1,5 +1,3 @@ - - --- title: Hugo and the General Data Protection Regulation (GDPR) linktitle: Hugo and GDPR @@ -98,7 +96,7 @@ useSessionStorage simple : If simple mode is enabled, a static and no-JS version of the Instagram image card will be built. Note that this only supports image cards and the image itself will be fetched from Instagram's servers. -**Note:** If you use the _simple mode_ for Instagram and a site styled with Bootstrap 4, you may want to disable the inlines styles provided by Hugo: +**Note:** If you use the _simple mode_ for Instagram and a site styled with Bootstrap 4, you may want to disable the inline styles provided by Hugo: {{< code-toggle file="config">}} [services] diff --git a/docs/content/en/about/security-model/index.md b/docs/content/en/about/security-model/index.md index 2d0eef873..7a7841131 100644 --- a/docs/content/en/about/security-model/index.md +++ b/docs/content/en/about/security-model/index.md @@ -1,6 +1,6 @@ --- title: Hugo's Security Model -description: A summary of Hugo's security model. +description: A summary of Hugo's security model. date: 2019-10-01 layout: single keywords: ["Security", "Privacy"] @@ -19,7 +19,7 @@ toc: true Hugo produces static output, so once built, the runtime is the browser (assuming the output is HTML) and any server (API) that you integrate with. -But when developing and building your site, the runtime is the `hugo` executable. Securing a runtime can be [a real challenge](https://blog.logrocket.com/how-to-protect-your-node-js-applications-from-malicious-dependencies-5f2e60ea08f9/). +But when developing and building your site, the runtime is the `hugo` executable. Securing a runtime can be [a real challenge](https://blog.logrocket.com/how-to-protect-your-node-js-applications-from-malicious-dependencies-5f2e60ea08f9/). **Hugo's main approach is that of sandboxing:** diff --git a/docs/content/en/about/what-is-hugo.md b/docs/content/en/about/what-is-hugo.md index 257c7e82d..b84f61f10 100644 --- a/docs/content/en/about/what-is-hugo.md +++ b/docs/content/en/about/what-is-hugo.md @@ -39,9 +39,7 @@ Hugo is for people who want to hand code their own website without worrying abou Hugo is for people building a blog, a company site, a portfolio site, documentation, a single landing page, or a website with thousands of pages. - - -[@spf13]: https://twitter.com/@spf13 +[@spf13]: https://twitter.com/spf13 [Aerobatic]: https://www.aerobatic.com/ [Amazon S3]: https://aws.amazon.com/s3/ [Azure]: https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blob-static-website @@ -51,7 +49,7 @@ Hugo is for people building a blog, a company site, a portfolio site, documentat [GitHub Pages]: https://pages.github.com/ [GitLab Pages]: https://about.gitlab.com/features/pages/ [Go language]: https://golang.org/ -[GoDaddy]: https://www.godaddy.com/ "Godaddy.com Hosting" +[GoDaddy]: https://www.godaddy.com/ "GoDaddy.com Hosting" [Google Cloud Storage]: https://cloud.google.com/storage/ [Heroku]: https://www.heroku.com/ [Jekyll]: https://jekyllrb.com/ @@ -61,5 +59,5 @@ Hugo is for people building a blog, a company site, a portfolio site, documentat [Rackspace]: https://www.rackspace.com/cloud/files [Surge]: https://surge.sh [contributing to it]: https://github.com/gohugoio/hugo -[rackspace]: https://www.rackspace.com/cloud/files +[rackspace]: https://www.rackspace.com/openstack/public/files [static site generator]: /about/benefits/ diff --git a/docs/content/en/commands/hugo.md b/docs/content/en/commands/hugo.md index fe519d397..9805034bf 100644 --- a/docs/content/en/commands/hugo.md +++ b/docs/content/en/commands/hugo.md @@ -15,7 +15,7 @@ hugo is the main command, used to build your Hugo site. Hugo is a Fast and Flexible Static Site Generator built with love by spf13 and friends in Go. -Complete documentation is available at http://gohugo.io/. +Complete documentation is available at https://gohugo.io/. ``` hugo [flags] diff --git a/docs/content/en/commands/hugo_mod_clean.md b/docs/content/en/commands/hugo_mod_clean.md index ff982f9f6..6411ed58c 100644 --- a/docs/content/en/commands/hugo_mod_clean.md +++ b/docs/content/en/commands/hugo_mod_clean.md @@ -15,7 +15,6 @@ Delete the Hugo Module cache for the current project. Note that after you run this command, all of your dependencies will be re-downloaded next time you run "hugo". Also note that if you configure a positive maxAge for the "modules" file cache, it will also be cleaned as part of "hugo --gc". - ``` diff --git a/docs/content/en/commands/hugo_mod_get.md b/docs/content/en/commands/hugo_mod_get.md index 7de0048bb..cf1060bfd 100644 --- a/docs/content/en/commands/hugo_mod_get.md +++ b/docs/content/en/commands/hugo_mod_get.md @@ -18,7 +18,7 @@ Some examples: Install the latest version possible for a given module: hugo mod get github.com/gohugoio/testshortcodes - + Install a specific version: hugo mod get github.com/gohugoio/testshortcodes@v0.3.0 diff --git a/docs/content/en/content-management/authors.md b/docs/content/en/content-management/authors.md index 2cbc11620..a39897dd8 100644 --- a/docs/content/en/content-management/authors.md +++ b/docs/content/en/content-management/authors.md @@ -18,8 +18,6 @@ toc: true comments: Before this page is published, need to also update both site- and page-level variables documentation. --- - - Larger sites often have multiple content authors. Hugo provides standardized author profiles to organize relationships between content and content creators for sites operating under a distributed authorship model. ## Author Profiles @@ -107,7 +105,7 @@ You can find a list of all template variables to access the profile information ### Link Social Network Accounts -As aforementioned, Hugo is able to generate links to profiles of the most popular social networks. The following social networks with their corresponding identifiers are supported: `github`, `facebook`, `twitter`, `pinterest`, `instagram`, `youtube` and `linkedin`. +As aforementioned, Hugo is able to generate links to profiles of the most popular social networks. The following social networks with their corresponding identifiers are supported: `github`, `facebook`, `twitter`, `pinterest`, `instagram`, `youtube` and `linkedin`. This is can be done with the `.Social.URL` function. Its only parameter is the name of the social network as they are defined in the profile (e.g. `facebook`, `twitter`). Custom variables like `website` remain as they are. diff --git a/docs/content/en/content-management/build-options.md b/docs/content/en/content-management/build-options.md index 028a15c9b..b01568d39 100644 --- a/docs/content/en/content-management/build-options.md +++ b/docs/content/en/content-management/build-options.md @@ -35,7 +35,7 @@ Note that we extended this property from a boolean to an enum in Hugo 0.68.0. Valid values are: never -: The page will not be incldued in any page collection. +: The page will not be included in any page collection. always (default) : The page will be included in all page collections, e.g. `site.RegularPages`, `$page.Pages`. diff --git a/docs/content/en/content-management/comments.md b/docs/content/en/content-management/comments.md index d7a467d10..b5357cba4 100644 --- a/docs/content/en/content-management/comments.md +++ b/docs/content/en/content-management/comments.md @@ -56,7 +56,7 @@ There are a few alternatives to commenting on static sites for those who do not * [IntenseDebate](https://intensedebate.com/) * [Graph Comment][] * [Muut](https://muut.com/) -* [isso](https://posativ.org/isso/) (Self-hosted, Python) +* [Isso](https://posativ.org/isso/) (Self-hosted, Python) * [Tutorial on Implementing Isso with Hugo][issotutorial] * [Utterances](https://utteranc.es/) (Open source, GitHub comments widget built on GitHub issues) * [Remark](https://github.com/umputun/remark) (Open source, Golang, Easy to run docker) diff --git a/docs/content/en/content-management/image-processing/index.md b/docs/content/en/content-management/image-processing/index.md index 075953093..745c2c53b 100644 --- a/docs/content/en/content-management/image-processing/index.md +++ b/docs/content/en/content-management/image-processing/index.md @@ -98,7 +98,7 @@ Sometimes it can be useful to create the filter chain once and then reuse it: Provides an [Exif](https://en.wikipedia.org/wiki/Exif) object with metadata about the image. -Note that this is only suported for JPEG and TIFF images, so it's recommended to wrap the access with a `with`, e.g.: +Note that this is only supported for JPEG and TIFF images, so it's recommended to wrap the access with a `with`, e.g.: ```go-html-template {{ with $img.Exif }} diff --git a/docs/content/en/content-management/multilingual.md b/docs/content/en/content-management/multilingual.md index 575393d47..ccf794b2e 100644 --- a/docs/content/en/content-management/multilingual.md +++ b/docs/content/en/content-management/multilingual.md @@ -63,7 +63,7 @@ When working with front matter `Params` in [single page templates][singles], omi `defaultContentLanguage` sets the project's default language. If not set, the default language will be `en`. -If the default language needs to be rendererd below its own language code (`/en`) like the others, set `defaultContentLanguageInSubdir: true`. +If the default language needs to be rendered below its own language code (`/en`) like the others, set `defaultCon |