Squashed 'docs/' changes from 63386081c..4c5edacfe

4c5edacfe cSpell config update (gohugoio#1700) 9df788b25 Fix broken link (hugo modules) (gohugoio#1710) 9928a70d6 Fix workspace formatting (gohugoio#1707) 55467e7c8 Update partials.md 9f4bd0023 Update formats.md 9b3913c86 Remove footnoteAnchorPrefix and footnoteReturnLinkContents (gohugoio#1704) 94502a09b Code block render hooks are introduced in v0.93.0 (gohugoio#1701) c447270ef Update sitemap-template.md 78665c1e0 Update sitemap-template.md 60653c17d Update the caddy error docs link (gohugoio#1696) 9a3675aad Update sitemap templates (gohugoio#1699) e0d08cdbb Add wpxr-to-static to list of migration tools (gohugoio#1512) b53eb5a08 Add page for deploying with rclone (gohugoio#1511) 4207c57ff netlify: Hugo 0.96.0 a18d646ea docs: Regen docshelper e3e0981ed docs: Regen CLI docs fda988d01 Merge commit 'd276e901b36d2576ef8350ed96b17f66254eac1b' e4a26dbca tpl/crypto: Add optional encoding arg to hmac function git-subtree-dir: docs git-subtree-split: 4c5edacfeebd13eb7f876723c065466cd50e0cae
jmooring · Apr 8, 2022 · ec92036 · ec92036
1 parent d276e90
commit ec92036
Show file tree

Hide file tree

Showing 27 changed files with 218 additions and 135 deletions.
diff --git a/.cspell.json b/.cspell.json
@@ -6,6 +6,8 @@
     "aabba",
     "aabbaa",
     "aabbaabb",
+    "aabbaabbab",
+    "abbaa",
     "abourget",
     "absurl",
     "adoc",
@@ -18,7 +20,11 @@
     "attrlink",
     "azblob",
     "baseof",
+    "bbaa",
+    "bcde",
+    "bcdef",
     "beevelop",
+    "Bergevin",
     "bibtex",
     "Bjørn",
     "blackfriday",
@@ -31,6 +37,7 @@
     "canonify",
     "Catmull",
     "Catwoman",
+    "changefreq",
     "Cheatsheet",
     "choco",
     "chromastyles",
@@ -42,12 +49,15 @@
     "Coen",
     "Commento",
     "Cond",
+    "contentdir",
     "Contentful",
+    "Copr",
     "copyrighthtml",
     "corejs",
     "countrunes",
     "countwords",
     "crossreferences",
+    "daftaupe",
     "datatable",
     "DATOCMS",
     "debugconfig",
@@ -60,6 +70,8 @@
     "dokuwiki",
     "dpkg",
     "DRING",
+    "Eiqc",
+    "Eliott",
     "Emojify",
     "Enwrite",
     "eopkg",
@@ -68,6 +80,7 @@
     "erroridf",
     "Evernote",
     "exitwp",
+    "expirydate",
     "Feminella",
     "firstpost",
     "Formspree",
@@ -95,7 +108,9 @@
     "Grayscale",
     "Gruber",
     "gtag",
+    "gvfs",
     "hidecaption",
+    "hmac",
     "Hokus",
     "hola",
     "hügó",
@@ -121,6 +136,7 @@
     "Isset",
     "Isso",
     "Jaco",
+    "JIRN",
     "johnpatitucci",
     "Joomla",
     "JRBR",
@@ -142,10 +158,13 @@
     "mathjax",
     "mdhender",
     "mdshortcode",
+    "MENUENTRY",
     "mercredi",
+    "Milli",
     "Mittwoch",
     "mkdir",
     "mmark",
+    "modh",
     "monokai",
     "Morling",
     "mspowerpoint",
@@ -155,17 +174,20 @@
     "mydeployment",
     "myindex",
     "mylayout",
+    "mylogin",
     "mypage",
     "mypartials",
     "mypost",
     "mysite",
     "myspa",
     "mystyle",
+    "mytextpartial",
     "mytheme",
     "NDJSON",
     "needsexample",
     "Netravali",
     "newparam",
+    "Nichlas",
     "Nikhil",
     "Njjy",
     "nlist",
@@ -176,6 +198,7 @@
     "NOSQL",
     "notoc",
     "novembre",
+    "numfmt",
     "NUMWORKERMULTIPLIER",
     "Obhu",
     "octohug",
@@ -191,35 +214,47 @@
     "PCRE",
     "peaceiris",
     "Pedersen",
+    "Pekka",
     "permalinkable",
     "plainify",
     "POSIX",
     "postprocess",
+    "Poupin",
+    "prerender",
     "println",
     "publishdate",
     "Pygments",
+    "qref",
     "querify",
     "QVOMC",
+    "Racic",
+    "Rclone",
     "rdwatters",
     "readfile",
     "rebinded",
+    "recommendedby",
     "REDIR",
     "reftext",
     "relatedfuncs",
     "relref",
     "relurl",
     "remarkjs",
     "rgba",
+    "Riku",
     "rlimit",
     "roboto",
     "rssxml",
     "rwxrwxrwx",
+    "RYUGV",
     "safehtml",
     "safejs",
     "Samsa",
+    "schemaorg",
     "Shekhar",
     "Shortcode",
     "Shortcodes",
+    "signup",
+    "Silvola",
     "Sindre",
     "sitemapindex",
     "sitemapxml",
@@ -231,24 +266,33 @@
     "struct",
     "structs",
     "subdir",
+    "svgs",
+    "symdiff",
     "Talkyard",
     "taxo",
+    "taxonomyname",
     "tbody",
     "tdewolff",
     "testshortcodes",
     "thead",
     "Thinkful",
+    "Tknx",
     "TLDR",
     "TMPDIR",
+    "TOCSS",
+    "todos",
     "tojson",
+    "Tomango",
+    "topologix",
     "Torikian",
     "totoml",
     "toyaml",
     "twitteruser",
     "Unmarshal",
-    "Unmarshal",
     "urlize",
     "urlset",
+    "utimestamp",
+    "vendored",
     "vimrc",
     "wanghc",
     "Wappalyzer",
@@ -258,19 +302,35 @@
     "wibble",
     "wordcount",
     "workson",
+    "wpxr",
+    "Xbaabbab",
     "xvzf",
     "yoyoyo",
     "Zgotmpl",
-    "zzbbaabb"
+    "zzbbaabb",
+    "مدونتي"
   ],
   "language": "en,en-GB,en-US,de,fr",
+  "allowCompoundWords": true,
   "files": [
     "**/*.md"
   ],
+  "ignoreRegExpList": [
+    "<!-- prettier-ignore -->\\n(`{3,})\\w*\\n[\\s\\S]+?\\1",
+    "\\[(\\*{2})?@\\w+?\\1\\]",
+    "\\[`\\w+`\\]",
+    "ve{2,}r{2,}y",
+    "ve+r+y+long\\w*",
+    "\\/.*?\\/",
+    "\\_\\w+",
+    "\\#\\w+"
+  ],
   "ignorePaths": [
     ".cspell.json",
     "**/node_modules/**",
-    "*.min.*"
+    "*.min.*",
+    "**/news/*",
+    "**/showcase/*"
   ],
   "useGitignore": true
 }
diff --git a/content/en/commands/hugo.md b/content/en/commands/hugo.md
@@ -14,7 +14,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]
@@ -23,7 +23,7 @@ hugo [flags]
 ### Options
 
 ```
-  -b, --baseURL string             hostname (and path) to the root, e.g. http://spf13.com/
+  -b, --baseURL string             hostname (and path) to the root, e.g. https://spf13.com/
   -D, --buildDrafts                include content marked as draft
   -E, --buildExpired               include expired content
   -F, --buildFuture                include content with publishdate in the future

diff --git a/content/en/commands/hugo_gen_doc.md b/content/en/commands/hugo_gen_doc.md
@@ -12,7 +12,7 @@ Generate Markdown documentation for the Hugo CLI.
 Generate Markdown documentation for the Hugo CLI.
 
 This command is, mostly, used to create up-to-date documentation
-of Hugo's command-line interface for http://gohugo.io/.
+of Hugo's command-line interface for https://gohugo.io/.
 
 It creates one Markdown file per command with front matter suitable
 for rendering in Hugo.

diff --git a/content/en/commands/hugo_mod.md b/content/en/commands/hugo_mod.md
@@ -26,7 +26,7 @@ See https://gohugo.io/hugo-modules/ for more information.
 ### Options
 
 ```
-  -b, --baseURL string         hostname (and path) to the root, e.g. http://spf13.com/
+  -b, --baseURL string         hostname (and path) to the root, e.g. https://spf13.com/
   -D, --buildDrafts            include content marked as draft
   -E, --buildExpired           include expired content
   -F, --buildFuture            include content with publishdate in the future

diff --git a/content/en/commands/hugo_new.md b/content/en/commands/hugo_new.md
@@ -25,7 +25,7 @@ hugo new [path] [flags]
 ### Options
 
 ```
-  -b, --baseURL string         hostname (and path) to the root, e.g. http://spf13.com/
+  -b, --baseURL string         hostname (and path) to the root, e.g. https://spf13.com/
   -D, --buildDrafts            include content marked as draft
   -E, --buildExpired           include expired content
   -F, --buildFuture            include content with publishdate in the future

diff --git a/content/en/commands/hugo_server.md b/content/en/commands/hugo_server.md
@@ -30,7 +30,7 @@ hugo server [flags]
 
 ```
       --appendPort             append port to baseURL (default true)
-  -b, --baseURL string         hostname (and path) to the root, e.g. http://spf13.com/
+  -b, --baseURL string         hostname (and path) to the root, e.g. https://spf13.com/
       --bind string            interface to which the server will bind (default "127.0.0.1")
   -D, --buildDrafts            include content marked as draft
   -E, --buildExpired           include expired content

diff --git a/content/en/content-management/formats.md b/content/en/content-management/formats.md
@@ -33,7 +33,7 @@ The current list of content formats in Hugo:
 |MMark|mmark|Mmark is deprecated and will be removed in a future release.|
 |Emacs Org-Mode|org|See [go-org](https://github.com/niklasfasching/go-org).|
 |AsciiDoc|asciidocext, adoc, ad|Needs [Asciidoctor][ascii] installed.|
-|RST|rst|Needs [RST](https://docutils.sourceforge.net/rst.html) installed.|
+|RST|rst|Needs [RST](https://docutils.sourceforge.io/rst.html) installed.|
 |Pandoc|pandoc, pdc|Needs [Pandoc](https://www.pandoc.org/) installed.|
 |HTML|html, htm|To be treated as a content file, with layout, shortcodes etc., it must have front matter. If not, it will be copied as-is.|
 

diff --git a/content/en/functions/cond.md b/content/en/functions/cond.md
@@ -11,7 +11,6 @@ hugoversion: 0.27
 relatedfuncs: [default]
 toc: false
 draft: false
-needsexamples: false
 ---
 
 `cond` returns *VAR1* if *CONTROL* is true, or *VAR2* if it is not.

diff --git a/content/en/functions/default.md b/content/en/functions/default.md
@@ -18,7 +18,6 @@ relatedfuncs: []
 deprecated: false
 draft: false
 aliases: []
-needsexamples: false
 ---
 
 `default` checks whether a given value is set and returns a default value if it is not. *Set* in this context means different things depending on the data type:

diff --git a/content/en/functions/hmac.md b/content/en/functions/hmac.md
@@ -1,7 +1,7 @@
 ---
 title: hmac
 linktitle: hmac
-description: Compute the cryptographic checksum of a message.
+description: Returns a cryptographic hash that uses a key to sign a message.
 date: 2020-05-29
 publishdate: 2020-05-29
 lastmod: 2020-05-29
@@ -10,24 +10,25 @@ menu:
   docs:
     parent: "functions"
 keywords: [hmac,checksum]
-signature: ["hmac HASH_TYPE KEY MESSAGE"]
+signature: ["crypto.HMAC HASH_TYPE KEY MESSAGE [ENCODING]","hmac HASH_TYPE KEY MESSAGE [ENCODING]" ]
 workson: []
 hugoversion:
 relatedfuncs: [hmac]
 deprecated: false
-aliases: [hmac]
+aliases: []
 ---
 
-`hmac` returns a cryptographic hash that uses a key to sign a message.
+Set the `HASH_TYPE` argument to `md5`, `sha1`, `sha256`, or `sha512`.
 
-```
-{{ hmac "sha256" "Secret key" "Hello world, gophers!"}},
-<!-- returns the string "b6d11b6c53830b9d87036272ca9fe9d19306b8f9d8aa07b15da27d89e6e34f40"
-```
+Set the optional `ENCODING` argument to either `hex` (default) or `binary`.
 
-Supported hash functions:
+```go-html-template
+{{ hmac "sha256" "Secret key" "Secret message" }}
+5cceb491f45f8b154e20f3b0a30ed3a6ff3027d373f85c78ffe8983180b03c84
 
-* md5
-* sha1
-* sha256
-* sha512
+{{ hmac "sha256" "Secret key" "Secret message" "hex" }}
+5cceb491f45f8b154e20f3b0a30ed3a6ff3027d373f85c78ffe8983180b03c84
+
+{{ hmac "sha256" "Secret key" "Secret message" "binary" | base64Encode }}
+XM60kfRfixVOIPOwow7Tpv8wJ9Nz+Fx4/+iYMYCwPIQ=
+```
diff --git a/content/en/functions/uniq.md b/content/en/functions/uniq.md
@@ -16,7 +16,6 @@ hugoversion:
 relatedfuncs: []
 deprecated: false
 aliases: []
-needsexamples: false
 ---
 
 ```