From efa74c5c6e6ff1daddeb5834ea7c69bed2acf171 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B8rn=20Erik=20Pedersen?= Date: Tue, 16 Jun 2020 14:18:51 +0200 Subject: [PATCH] Squashed 'docs/' changes from 9be494de3..ac2c4a487 ac2c4a487 Update documentation for Ugly URLs (#1082) 88bdec17a Change 072.0 to 0.72.0 in release post's description 2aa7d7818 Update rss.md (#1104) c80677aeb Update quick-start.md (#1076) d04196bbd Minor spelling and capitalization fixes 837d2feba Fixed spelling mistake 67dc78e12 Update installing.md ce280c5d6 Update relurl.md bb4d0e703 Capitalization and Redirecting URL fixes e1fecada0 Update partials.md 1d99bb182 Typos and whitespacing issues fixed b20dba125 actually fix index function link this time f47d6f1e3 Fixing typos, whitespace issues and links dc82309b9 fix link to the index function 1eab0cbea add missing word (#1130) 9c3ee62ae more fixes e9bc5880a whitespace, typos and HTTPS fixes 93b806493 Add missing word to Module section 80ced9062 Display image on page bundles page. 727029b0a Update index.md 51fc48e4d Release 0.72.0 1ff68ac3b releaser: Add release notes to /docs for release of 0.72.0 f74a25b92 common/maps: Add Scratch.Values 2fd83db96 Add redirect support to the server bdfccf9f4 Fix typo in install instructions e12737ea6 Create SUPPORT.md git-subtree-dir: docs git-subtree-split: ac2c4a4871e90ddfb180f23704ce7ec9023529ca --- .github/SUPPORT.md | 3 ++ content/en/about/benefits.md | 2 +- content/en/about/features.md | 2 +- content/en/about/hugo-and-gdpr.md | 4 +- content/en/about/security-model/index.md | 4 +- content/en/about/what-is-hugo.md | 8 ++-- content/en/commands/hugo.md | 2 +- content/en/commands/hugo_mod_clean.md | 1 - content/en/commands/hugo_mod_get.md | 2 +- content/en/content-management/authors.md | 4 +- .../en/content-management/build-options.md | 2 +- content/en/content-management/comments.md | 2 +- .../image-processing/index.md | 2 +- content/en/content-management/multilingual.md | 6 +-- .../content-management/organization/index.md | 6 +-- .../en/content-management/page-resources.md | 2 +- content/en/content-management/shortcodes.md | 4 +- content/en/content-management/urls.md | 2 +- content/en/documentation.md | 3 +- content/en/functions/findRe.md | 4 +- content/en/functions/getenv.md | 2 +- content/en/functions/htmlEscape.md | 2 +- content/en/functions/htmlUnescape.md | 4 +- content/en/functions/hugo.md | 4 +- content/en/functions/index-function.md | 3 -- content/en/functions/last.md | 1 - content/en/functions/md5.md | 2 - content/en/functions/plainify.md | 5 +-- content/en/functions/relurl.md | 2 +- content/en/functions/scratch.md | 5 +++ content/en/functions/seq.md | 2 +- content/en/functions/templates.Exists.md | 2 +- content/en/functions/time.md | 2 +- content/en/functions/unix.md | 2 - content/en/functions/urls.Parse.md | 2 +- content/en/getting-started/configuration.md | 14 ++++++ .../external-learning-resources/index.md | 8 +++- content/en/getting-started/installing.md | 6 ++- content/en/getting-started/quick-start.md | 4 +- .../deployment-with-rsync.md | 2 +- .../hosting-on-aws-amplify.md | 2 +- .../hosting-on-github.md | 2 +- .../hosting-on-keycdn.md | 8 ++-- content/en/hugo-modules/configuration.md | 4 +- content/en/hugo-modules/use-modules.md | 8 ++-- content/en/hugo-pipes/bundling.md | 4 +- content/en/hugo-pipes/fingerprint.md | 2 +- content/en/hugo-pipes/introduction.md | 2 +- content/en/hugo-pipes/minification.md | 2 +- content/en/hugo-pipes/postprocess.md | 2 +- .../news/0.72.0-relnotes/hugo-72-featured.png | Bin 0 -> 256988 bytes content/en/news/0.72.0-relnotes/index.md | 41 ++++++++++++++++++ content/en/news/http2-server-push-in-hugo.md | 8 ++-- .../en/showcase/1password-support/index.md | 2 +- content/en/showcase/arolla-cocoon/index.md | 2 +- content/en/showcase/fireship/index.md | 11 +++-- content/en/showcase/hapticmedia/index.md | 2 +- content/en/showcase/linode/index.md | 6 --- .../showcase/pace-revenue-management/index.md | 2 +- .../index.md | 2 +- content/en/showcase/stackimpact/index.md | 5 --- content/en/showcase/template/index.md | 2 +- content/en/templates/introduction.md | 2 +- content/en/templates/partials.md | 19 +------- content/en/templates/rss.md | 2 +- content/en/tools/frontends.md | 2 +- content/en/tools/migrations.md | 12 ++--- content/en/tools/search.md | 2 +- content/en/troubleshooting/_index.md | 7 +-- content/en/troubleshooting/faq.md | 2 +- content/en/variables/files.md | 4 +- content/en/variables/hugo.md | 2 +- data/articles.toml | 4 +- netlify.toml | 8 ++-- ...cdd29_256988_480x0_resize_catmullrom_2.png | Bin 0 -> 85162 bytes ...cdd29_256988_640x0_resize_catmullrom_2.png | Bin 0 -> 145874 bytes 76 files changed, 170 insertions(+), 154 deletions(-) create mode 100644 .github/SUPPORT.md create mode 100644 content/en/news/0.72.0-relnotes/hugo-72-featured.png create mode 100644 content/en/news/0.72.0-relnotes/index.md create mode 100644 resources/_gen/images/news/0.72.0-relnotes/hugo-72-featured_hu2851378649aa18f104ac3bb6a49cdd29_256988_480x0_resize_catmullrom_2.png create mode 100644 resources/_gen/images/news/0.72.0-relnotes/hugo-72-featured_hu2851378649aa18f104ac3bb6a49cdd29_256988_640x0_resize_catmullrom_2.png diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md new file mode 100644 index 000000000..cc9de09ff --- /dev/null +++ b/.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/content/en/about/benefits.md b/content/en/about/benefits.md index 16d43e48f..020e58981 100644 --- a/content/en/about/benefits.md +++ b/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/content/en/about/features.md b/content/en/about/features.md index a1e741ac0..9c8fac4f4 100644 --- a/content/en/about/features.md +++ b/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/content/en/about/hugo-and-gdpr.md b/content/en/about/hugo-and-gdpr.md index e193e1838..7c1c9bed4 100644 --- a/content/en/about/hugo-and-gdpr.md +++ b/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/content/en/about/security-model/index.md b/content/en/about/security-model/index.md index 2d0eef873..7a7841131 100644 --- a/content/en/about/security-model/index.md +++ b/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/content/en/about/what-is-hugo.md b/content/en/about/what-is-hugo.md index 257c7e82d..b84f61f10 100644 --- a/content/en/about/what-is-hugo.md +++ b/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/content/en/commands/hugo.md b/content/en/commands/hugo.md index fe519d397..9805034bf 100644 --- a/content/en/commands/hugo.md +++ b/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/content/en/commands/hugo_mod_clean.md b/content/en/commands/hugo_mod_clean.md index ff982f9f6..6411ed58c 100644 --- a/content/en/commands/hugo_mod_clean.md +++ b/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/content/en/commands/hugo_mod_get.md b/content/en/commands/hugo_mod_get.md index 7de0048bb..cf1060bfd 100644 --- a/content/en/commands/hugo_mod_get.md +++ b/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/content/en/content-management/authors.md b/content/en/content-management/authors.md index 2cbc11620..a39897dd8 100644 --- a/content/en/content-management/authors.md +++ b/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/content/en/content-management/build-options.md b/content/en/content-management/build-options.md index 028a15c9b..b01568d39 100644 --- a/content/en/content-management/build-options.md +++ b/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/content/en/content-management/comments.md b/content/en/content-management/comments.md index d7a467d10..b5357cba4 100644 --- a/content/en/content-management/comments.md +++ b/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/content/en/content-management/image-processing/index.md b/content/en/content-management/image-processing/index.md index 075953093..745c2c53b 100644 --- a/content/en/content-management/image-processing/index.md +++ b/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/content/en/content-management/multilingual.md b/content/en/content-management/multilingual.md index 575393d47..ccf794b2e 100644 --- a/content/en/content-management/multilingual.md +++ b/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 `defaultContentLanguageInSubdir: true`. Only the obvious non-global options can be overridden per language. Examples of global options are `baseURL`, `buildDrafts`, etc. @@ -125,7 +125,7 @@ public **All URLs (i.e `.Permalink` etc.) will be generated from that root. So the English home page above will have its `.Permalink` set to `https://example.com/`.** -When you run `hugo server` we will start multiple HTTP servers. You will typlically see something like this in the console: +When you run `hugo server` we will start multiple HTTP servers. You will typically see something like this in the console: ```bash Web Server is available at 127.0.0.1:1313 (bind address 127.0.0.1) @@ -204,7 +204,7 @@ languages: The value of `contentDir` can be any valid path -- even absolute path references. The only restriction is that the content directories cannot overlap. -Considering the following example in conjunction with the configuration above: +Considering the following example in conjunction with the configuration above: 1. `/content/english/about.md` 2. `/content/french/about.md` diff --git a/content/en/content-management/organization/index.md b/content/en/content-management/organization/index.md index 64d32781a..fa4c02520 100644 --- a/content/en/content-management/organization/index.md +++ b/content/en/content-management/organization/index.md @@ -23,9 +23,9 @@ Hugo `0.32` announced page-relative images and other resources packaged into `Pa These terms are connected, and you also need to read about [Page Resources]({{< relref "/content-management/page-resources" >}}) and [Image Processing]({{< relref "/content-management/image-processing" >}}) to get the full picture. -{{% imgproc 1-featured Resize "300x" %}} +{{< imgproc 1-featured Resize "300x" >}} The illustration shows 3 bundles. Note that the home page bundle cannot contain other content pages, but other files (images etc.) are fine. -{{% /imgproc %}} +{{< /imgproc >}} {{% note %}} @@ -112,7 +112,7 @@ Single content files in each of your sections are going to be rendered as [singl content/posts/my-first-hugo-post.md ``` -At the time Hugo builds your site, the content will be output to the following destination: +When Hugo builds your site, the content will be outputted to the following destination: ``` diff --git a/content/en/content-management/page-resources.md b/content/en/content-management/page-resources.md index 83afb133b..75c40ce6e 100644 --- a/content/en/content-management/page-resources.md +++ b/content/en/content-management/page-resources.md @@ -82,7 +82,7 @@ GetMatch ## Page Resources Metadata -The page resources' metadata is managed from the corresponding page's front matter with an array/table parameter named `resources`. You can batch assign values using [wildcards](http://tldp.org/LDP/GNU-Linux-Tools-Summary/html/x11655.htm). +The page resources' metadata is managed from the corresponding page's front matter with an array/table parameter named `resources`. You can batch assign values using [wildcards](https://tldp.org/LDP/GNU-Linux-Tools-Summary/html/x11655.htm). {{% note %}} Resources of type `page` get `Title` etc. from their own front matter. diff --git a/content/en/content-management/shortcodes.md b/content/en/content-management/shortcodes.md index 599ce159c..b565ffafa 100644 --- a/content/en/content-management/shortcodes.md +++ b/content/en/content-management/shortcodes.md @@ -21,7 +21,7 @@ toc: true ## What a Shortcode is -Hugo loves Markdown because of its simple content format, but there are times when Markdown falls short. Often, content authors are forced to add raw HTML (e.g., video ``) to Markdown content. We think this contradicts the beautiful simplicity of Markdown's syntax. +Hugo loves Markdown because of its simple content format, but there are times when Markdown falls short. Often, content authors are forced to add raw HTML (e.g., video `