Squashed 'docs/' changes from 63386081c..4c5edacfe
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Fri, 8 Apr 2022 11:32:01 +0000 (13:32 +0200)
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Fri, 8 Apr 2022 11:32:01 +0000 (13:32 +0200)
4c5edacfe cSpell config update (#1700)
9df788b25 Fix broken link (hugo modules) (#1710)
9928a70d6 Fix workspace formatting (#1707)
55467e7c8 Update partials.md
9f4bd0023 Update formats.md
9b3913c86 Remove footnoteAnchorPrefix and footnoteReturnLinkContents (#1704)
94502a09b Code block render hooks are introduced in v0.93.0 (#1701)
c447270ef Update sitemap-template.md
78665c1e0 Update sitemap-template.md
60653c17d Update the caddy error docs link (#1696)
9a3675aad Update sitemap templates (#1699)
e0d08cdbb Add wpxr-to-static to list of migration tools (#1512)
b53eb5a08 Add page for deploying with rclone (#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

27 files changed:
.cspell.json
content/en/commands/hugo.md
content/en/commands/hugo_gen_doc.md
content/en/commands/hugo_mod.md
content/en/commands/hugo_new.md
content/en/commands/hugo_server.md
content/en/content-management/formats.md
content/en/functions/cond.md
content/en/functions/default.md
content/en/functions/hmac.md
content/en/functions/uniq.md
content/en/getting-started/configuration.md
content/en/hosting-and-deployment/deployment-with-rclone.md [new file with mode: 0644]
content/en/hosting-and-deployment/hosting-on-keycdn.md
content/en/hosting-and-deployment/hosting-on-render.md
content/en/hugo-modules/configuration.md
content/en/hugo-modules/use-modules.md
content/en/showcase/hapticmedia/index.md
content/en/templates/404.md
content/en/templates/ordering-and-grouping.md
content/en/templates/partials.md
content/en/templates/render-hooks.md
content/en/templates/sitemap-template.md
content/en/tools/migrations.md
data/docs.json
layouts/maintenance/list.html
netlify.toml

index 2cac73c022e157dd85e931bd8fd429bd5c322aa4..84631ce67d31b3e34a868cad269811c37fff3f1e 100644 (file)
@@ -6,6 +6,8 @@
     "aabba",
     "aabbaa",
     "aabbaabb",
+    "aabbaabbab",
+    "abbaa",
     "abourget",
     "absurl",
     "adoc",
     "attrlink",
     "azblob",
     "baseof",
+    "bbaa",
+    "bcde",
+    "bcdef",
     "beevelop",
+    "Bergevin",
     "bibtex",
     "Bjørn",
     "blackfriday",
@@ -31,6 +37,7 @@
     "canonify",
     "Catmull",
     "Catwoman",
+    "changefreq",
     "Cheatsheet",
     "choco",
     "chromastyles",
     "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",
     "Grayscale",
     "Gruber",
     "gtag",
+    "gvfs",
     "hidecaption",
+    "hmac",
     "Hokus",
     "hola",
     "hügó",
     "Isset",
     "Isso",
     "Jaco",
+    "JIRN",
     "johnpatitucci",
     "Joomla",
     "JRBR",
     "mathjax",
     "mdhender",
     "mdshortcode",
+    "MENUENTRY",
     "mercredi",
+    "Milli",
     "Mittwoch",
     "mkdir",
     "mmark",
+    "modh",
     "monokai",
     "Morling",
     "mspowerpoint",
     "mydeployment",
     "myindex",
     "mylayout",
+    "mylogin",
     "mypage",
     "mypartials",
     "mypost",
     "mysite",
     "myspa",
     "mystyle",
+    "mytextpartial",
     "mytheme",
     "NDJSON",
     "needsexample",
     "Netravali",
     "newparam",
+    "Nichlas",
     "Nikhil",
     "Njjy",
     "nlist",
     "NOSQL",
     "notoc",
     "novembre",
+    "numfmt",
     "NUMWORKERMULTIPLIER",
     "Obhu",
     "octohug",
     "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",
     "relurl",
     "remarkjs",
     "rgba",
+    "Riku",
     "rlimit",
     "roboto",
     "rssxml",
     "rwxrwxrwx",
+    "RYUGV",
     "safehtml",
     "safejs",
     "Samsa",
+    "schemaorg",
     "Shekhar",
     "Shortcode",
     "Shortcodes",
+    "signup",
+    "Silvola",
     "Sindre",
     "sitemapindex",
     "sitemapxml",
     "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",
     "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
 }
index df32da7931f4db9698e3ac816b44be734d6f1ae6..afae767471faace491f68aa7e979e6cec0e82699 100644 (file)
@@ -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
index 158f3728baae32348871a9b95b581af8c5665733..6dc7dcf41b7144ae52713090728d37f135c09293 100644 (file)
@@ -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.
index 66a076322fdd5177755d9646b34cec4eac57211f..4a154383577be9f72c24791b289876011b31b689 100644 (file)
@@ -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
index 36a841b96a7569ac084a72619fe41dfac5793b6b..a396ef80718d34830ca33720d88eaf378aecdb06 100644 (file)
@@ -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
index cd9a85cac2c2089658e66a190857d6e97c89a48c..33b95d51c2fa947482ee8d9b86b8580f0005def8 100644 (file)
@@ -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
index 3c3edfdd496a3d6e60f9cc8160795ff56af9ad16..0b25c3171e330a4f5265f443e3e8dc2debfb606e 100644 (file)
@@ -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.|
 
index a5e5344268c8e49a0a3dcac3cb74409946b8d831..30b85325198c9bb32f6c205ed99e48262dbb97ff 100644 (file)
@@ -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.
index eee00b2002ea5f4f74ec05c5076d64b4b7ac804d..c4cc166a78258bbc2b868f3aad96726c7844ad78 100644 (file)
@@ -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:
index 9df36d30011cd6578c93ca8974d9c1db2e128427..b906e5abb0220c390a4970139e2c600859be2d47 100644 (file)
@@ -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=
+```
index 0a720f88fd62ad962d59fa59b541dba52ae4b8b8..eec55e5c3102af158ac2d324e6710b719c93a2ee 100644 (file)
@@ -16,7 +16,6 @@ hugoversion:
 relatedfuncs: []
 deprecated: false
 aliases: []
-needsexamples: false
 ---
 
 ```
index aed0ea100612351eeed1a8f0d34566cf49521d0d..d377487c57aef3687b79dabcfe07090069a2e522 100644 (file)
@@ -46,7 +46,7 @@ In addition to using a single site config file, one can use the `configDir` dire
 
 - Each file represents a configuration root object, such as `params.toml` for `[Params]`, `menu(s).toml` for `[Menu]`, `languages.toml` for `[Languages]` etc...
 - Each file's content must be top-level, for example:
-  
+
 {{< code-toggle file="config" >}}
 [Params]
   foo = "bar"
@@ -220,7 +220,7 @@ Disable automatic live reloading of browser window.
 
 : Do not convert the url/path to lowercase.
 
-### enableEmoji 
+### enableEmoji
 
 **Default value:**  false
 
@@ -254,18 +254,6 @@ Enable generation of `robots.txt` file.
 
 See [Front matter Configuration](#configure-front-matter).
 
-### footnoteAnchorPrefix
-
-**Default value:**  ""
-
-Prefix for footnote anchors.
-
-###  footnoteReturnLinkContents
-
-**Default value:**  ""
-
-Text to display for footnote return links.
-
 ### googleAnalytics
 
 **Default value:**  ""
@@ -279,6 +267,7 @@ Google Analytics tracking ID.
 If true, auto-detect Chinese/Japanese/Korean Languages in the content. This will make `.Summary` and `.WordCount` behave correctly for CJK languages.
 
 ### imaging
+
 See [Image Processing Config](/content-management/image-processing/#image-processing-config).
 
 ### languageCode
@@ -288,6 +277,7 @@ See [Image Processing Config](/content-management/image-processing/#image-proces
 A language tag as defined by [RFC 5646](https://datatracker.ietf.org/doc/html/rfc5646). The internal [RSS template](https://github.com/gohugoio/hugo/blob/master/tpl/tplimpl/embedded/templates/_default/rss.xml) populates its `<language>` element with this value. The value is not used elsewhere.
 
 ### languages
+
 See [Configure Languages](/content-management/multilingual/#configure-languages).
 
 ### disableLanguages
@@ -330,7 +320,7 @@ Don't sync modification time of files.
 ### outputFormats
 See [Configure Output Formats](#configure-additional-output-formats).
 
-### paginate 
+### paginate
 
 **Default value:** 10
 
@@ -568,7 +558,6 @@ The following is a typical example of a configuration file. The values nested un
 {{< code-toggle file="config">}}
 baseURL: "https://yoursite.example.com/"
 title: "My Hugo Site"
-footnoteReturnLinkContents: "↩"
 permalinks:
   posts: /:year/:month/:title/
 params:
diff --git a/content/en/hosting-and-deployment/deployment-with-rclone.md b/content/en/hosting-and-deployment/deployment-with-rclone.md
new file mode 100644 (file)
index 0000000..e9feb76
--- /dev/null
@@ -0,0 +1,57 @@
+---
+title: Deployment with Rclone
+linktitle: Deployment with Rclone
+description: If you have access to your web host with SFTP/FTP/SSH/HTTP(DAV), you can use rclone to incrementally deploy your entire Hugo website.
+date: 2021-08-09
+publishdate: 2021-08-09
+lastmod: 2021-08-09
+categories: [hosting and deployment]
+keywords: [rclone,sftp,deployment]
+authors: [Daniel F. Dickinson]
+menu:
+  docs:
+    parent: "hosting-and-deployment"
+    weight: 80
+weight: 80
+sections_weight: 80
+draft: false
+aliases: [/tutorials/deployment-with-rclone/]
+toc: true
+notesforauthors:
+---
+
+## Assumptions
+
+* A web host running a web server. This could be a shared hosting environment or a VPS.
+* Access to your web host with any of the [protocols supported by rclone](https://rclone.org/#providers), such as SFTP.
+* A functional static website built with Hugo
+* Deploying from an [Rclone](https://rclone.org) compatible operating system
+* You have [installed Rclone](https://rclone.org/install/).
+
+**NB**: You can remove ``--interactive`` in the commands below once you are comfortable with rclone, if you wish. Also, ``--gc`` and ``--minify`` are optional in the ``hugo`` commands below.
+
+## Getting Started
+
+The spoiler is that you can even deploy your entire website from any compatible OS with no configuration. Using SFTP for example:
+
+```
+hugo --gc --minify
+rclone sync --interactive --sftp-host sftp.example.com --sftp-user www-data --sftp-ask-password public/ :sftp:www/
+```
+
+## Configure Rclone for Even Easier Usage
+
+The easiest way is simply to run ``rclone config``.
+
+The [Rclone docs](https://rclone.org/docs/) provide [an example of configuring Rclone to use SFTP](https://rclone.org/sftp/).
+
+For the next commands, we will assume you configured a remote you named ``hugo-www``
+
+The above 'spoiler' commands could become:
+
+```
+hugo --gc --minify
+rclone sync --interactive public/ hugo-www:www/
+```
+
+After you issue the above commands (and respond to any prompts), check your website and you will see that it is deployed.
index 8d9cb0e635ec09ad68428fa4b96f24d46a598f29..bec8b36e42c14325335f37a90086ba69f4b9a748 100644 (file)
@@ -83,11 +83,11 @@ The Zone ID and API key are used to purge your zone – it’s not strictly need
 Now it’s time to push the newly created repository to GitLab:
 
 ```
-git remote add origin git@gitlab.com:youruser/ciexample.git
+git remote add origin git@gitlab.com:youruser/ci-example.git
 git push -u origin master
 ```
 
-You can watch the progress and CI job output in your Gitlab project under “Pipelines”. 
+You can watch the progress and CI job output in your Gitlab project under “Pipelines”.
 
 After verifying your CI job ran without issues, first check that your GitLab page shows up under `https://youruser.gitlab.io/reponame/` (it might look broken depending on your browser settings as all links point to your KeyCDN zone – don’t worry about that) and then by heading to whatever Zone alias / Zone URL you defined.
 
index 7a77742e236ee0914759612785d6a055e8ba9349..73b20bcb2bea4777a30b158063eec9d74223d184 100644 (file)
@@ -4,7 +4,6 @@ linktitle: Host on Render
 description: Host your Hugo site for free with Render's global CDN, fully-managed SSL and auto deploys from GitHub.
 date: 2019-06-06
 publishdate: 2019-06-06
-lastmod: 2020-01-01
 categories: [hosting and deployment]
 keywords: [hosting,deployment]
 authors: [Anurag Goel]
@@ -88,5 +87,4 @@ Render automatically downloads all Git submodules defined in your Git repo on ev
 
 Chat with Render developers at https://render.com/chat or email `support@render.com` if you need help.
 
-
 [Quick Start]: /getting-started/quick-start/
index c66d93a6dfd57519dc19350e576a4a98e3054667..70de492ab4bf822e1a4f21d6c1c7f406ea35cdac 100644 (file)
@@ -43,10 +43,10 @@ private
 : Comma separated glob list matching paths that should be treated as private.
 
 workspace {{< new-in "0.83.0" >}}
-The workspace file to use. This enables Go workspace mode. Note that this can also be set via OS env, e.g. `export HUGO_MODULE_WORKSPACE=/my/hugo.work` This only works with Go 1.18+.
+The workspace file to use. This enables Go workspace mode. Note that this can also be set via OS env, e.g. `export HUGO_MODULE_WORKSPACE=/my/hugo.work` This only works with Go 1.18+.
 
 replacements {{< new-in "0.77.0" >}}
-: A comma separated (or a slice) list of module path to directory replacement mapping, e.g. `github.com/bep/myprettytheme -> ../..,github.com/bep/shortcodes -> /some/path`. This is mostly useful for temporary locally development of a module, and then it makes sense to set it as an OS environment variable, e.g: `env HUGO_MODULE_REPLACEMENTS="github.com/bep/myprettytheme -> ../.."`. Any relative path is relate to [themesDir](https://gohugo.io/getting-started/configuration/#all-configuration-settings), and absolute paths are allowed.
+: A comma separated (or a slice) list of module path to directory replacement mapping, e.g. `github.com/bep/my-theme -> ../..,github.com/bep/shortcodes -> /some/path`. This is mostly useful for temporary locally development of a module, and then it makes sense to set it as an OS environment variable, e.g: `env HUGO_MODULE_REPLACEMENTS="github.com/bep/my-theme -> ../.."`. Any relative path is relate to [themesDir](https://gohugo.io/getting-started/configuration/#all-configuration-settings), and absolute paths are allowed.
 
 Note that the above terms maps directly to their counterparts in Go Modules. Some of these setting may be natural to set as OS environment variables. To set the proxy server to use, as an example:
 
index e0d73957aa8c10fe693dd3a71a8d174715317450..038e0bf89e4a97fb580c93c4d50478ce2cec3442 100644 (file)
@@ -136,7 +136,7 @@ Also see the [CLI Doc](/commands/hugo_mod_clean/).
 
 Run `hugo mod clean` to delete the entire modules cache.
 
-Note that you can also configure the `modules` cache with a `maxAge`, see [File Caches](/hugo-modules/configuration/#configure-file-caches).
+Note that you can also configure the `modules` cache with a `maxAge`, see [File Caches](/getting-started/configuration/#configure-file-caches).
 
 
 
index b32879b6954f23b6c36412a3e0bf27b233e42705..85ec17a8b95b8698d9e62d33c65d2cbf50c56e5d 100644 (file)
@@ -18,7 +18,7 @@ Hugo addresses all these needs, coupled with [Forestry.io](https://forestry.io/)
 - The **multilingual** content support, especially simple to setup.
 - The **multiple environments** support (develop, staging, test, production, ...).
 - Although a hard start with the Go language, the power of the **Hugo's templating**.
-- The **partial layouts**, including the `internals` (e.g. social metas).
+- The **partial layouts**, including the `internals` (e.g. social meta tags).
 - The **build time**, unbeatable ⚡️⚡️⚡️.
 
 
@@ -30,4 +30,3 @@ Hugo addresses all these needs, coupled with [Forestry.io](https://forestry.io/)
 - **[Forestry.io](https://forestry.io)** for the content management.
 
 **All of these tools allow our editor to manage the blog's content without having to worry about its technical aspect, which is managed by the developers.**
-
index 1b82e9ebf20aa28f087749453721c726bccd808c..a2d06cf812c739810288c10130fa2a096bd93e61 100644 (file)
@@ -51,7 +51,7 @@ Your 404.html file can be set to load automatically when a visitor enters a mist
 * Nginx. You might specify `error_page 404 /404.html;` in your `nginx.conf` file. [Details here](https://nginx.org/en/docs/http/ngx_http_core_module.html#error_page).
 * Amazon AWS S3. When setting a bucket up for static web serving, you can specify the error file from within the S3 GUI.
 * Amazon CloudFront. You can specify the page in the Error Pages section in the CloudFront Console. [Details here](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html)
-* Caddy Server. Using `errors { 404 /404.html }`. [Details here](https://caddyserver.com/docs/errors)
+* Caddy Server. Use the `handle_errors` directive to specify error pages for one or more status codes. [Details here](https://caddyserver.com/docs/caddyfile/directives/handle_errors)
 * Netlify. Add `/* /404.html 404` to `content/_redirects`. [Details Here](https://www.netlify.com/docs/redirects/#custom-404)
 * Azure Static website. You can specify the `Error document path` in the Static website configuration page of the Azure portal. [More details are available in the Static website documentation](https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blob-static-website).
 
index a4f238fdfbc8ea666c4320ae5e6d4456a24b3b1b..f1634c7d8e458bde7efca0e6e23f0393cdfb7165 100644 (file)
@@ -1,5 +1,5 @@
 ---
-title: Ordere and Grouping Hugo Lists
+title: Ordering and Grouping Hugo Lists
 linktitle: List Ordering and Grouping
 description: You can group or order your content in both your templating and content front matter.
 date: 2017-02-01
@@ -19,7 +19,7 @@ toc: true
 notes: This was originally going to be a separate page on the new docs site but it now makes more sense to keep everything within the templates/lists page. - rdwatters, 2017-03-12.
 ---
 
-In Hugo, A list template is any template that will be used to render multiple pieces of content in a single HTML page.
+In Hugo, a list template is any template that will be used to render multiple pieces of content in a single HTML page.
 
 ## Example List Templates
 
index 2d1e9edf2e070e0ff9541c24bb81018fc5918600..56a676d7eae7e320ee050d78949c0f320b52bd1c 100644 (file)
@@ -78,7 +78,7 @@ This means the partial will *only* be able to access those variables. The partia
 
 ## Returning a value from a Partial
 
-In addition to outputting markup, partials can be used to return a value of any type. In order to return a value, a partial must include a lone `return` statement.
+In addition to outputting markup, partials can be used to return a value of any type. In order to return a value, a partial must include a lone `return` statement _at the end of the partial_.
 
 ### Example GetFeatured
 
index 57c2efa06897938c5260abfc63f72cb0901b45b4..8f1a55c2fac9d233e98fcd72b8d811f9d0f644d1 100644 (file)
@@ -25,7 +25,7 @@ The hook kinds currently supported are:
 * `image`
 * `link`
 * `heading` {{< new-in "0.71.0" >}}
-* `codeblock`{{< new-in "0.83.0" >}}
+* `codeblock`{{< new-in "0.93.0" >}}
 
 You can define [Output-Format-](/templates/output-formats) and [language-](/content-management/multilingual/)specific templates if needed. Your `layouts` folder may look like this:
 
index dee28fc3ba8574851bb07eb6c83e2d17708a7c5d..9fc817020dd4d53d578c1ef959f3ff093b7960e9 100644 (file)
@@ -1,10 +1,7 @@
 ---
-title: Sitemap Template
-# linktitle: Sitemap
-description: Hugo ships with a built-in template file observing the v0.9 of the Sitemap Protocol, but you can override this template if needed.
+title: Sitemap Templates
+description: Hugo provides built-in sitemap templates.
 date: 2017-02-01
-publishdate: 2017-02-01
-lastmod: 2017-02-01
 categories: [templates]
 keywords: [sitemap, xml, templates]
 menu:
@@ -15,92 +12,76 @@ weight: 160
 sections_weight: 160
 draft: false
 aliases: [/layout/sitemap/,/templates/sitemap/]
-toc: false
+toc: true
 ---
 
-A single Sitemap template is used to generate the `sitemap.xml` file.
-Hugo automatically comes with this template file. *No work is needed on
-the users' part unless they want to customize `sitemap.xml`.*
+## Overview
 
-A sitemap is a `Page` and therefore has all the [page variables][pagevars] available to use in this template along with Sitemap-specific ones:
+Hugo's built-in sitemap templates conform to v0.9 of the [sitemap protocol].
 
-`.Sitemap.ChangeFreq`
-: The page change frequency
+With a monolingual project, Hugo generates a sitemap.xml file in the root of the [`publishDir`] using the built-in [sitemap.xml] template.
 
-`.Sitemap.Priority`
-: The priority of the page
+With a multilingual project, Hugo generates:
 
-`.Sitemap.Filename`
-: The sitemap filename
+- A sitemap.xml file in the root of each site (language) using the built-in [sitemap.xml] template
+- A sitemap.xml file in the root of the [`publishDir`] using the built-in [sitemapindex.xml] template
 
-If provided, Hugo will use `/layouts/sitemap.xml` instead of the internal `sitemap.xml` template that ships with Hugo.
+## Configuration
 
-## Sitemap Templates
+Set the default values for [change frequency] and [priority], and the name of the generated file, in your site configuration.
 
-Hugo has built-on Sitemap templates, but you can provide your own if needed, in either `layouts/sitemap.xml` or `layouts/_default/sitemap.xml`.
+{{< code-toggle file="config" >}}
+[sitemap]
+  changefreq = 'monthly'
+  filename = 'sitemap.xml'
+  priority = 0.5
+{{</ code-toggle >}}
 
-For multilingual sites, we also create a Sitemap index. You can provide a custom layout for that in either `layouts/sitemapindex.xml` or `layouts/_default/sitemapindex.xml`.
+changefreq
+: How frequently a page is likely to change. Valid values are `always`, `hourly`, `daily`, `weekly`, `monthly`, `yearly`, and `never`. Default is `""` (change frequency omitted from rendered sitemap).
 
-## Hugo’s sitemap.xml
+filename
+: The name of the generated file. Default is `sitemap.xml`.
 
-This template respects the version 0.9 of the [Sitemap Protocol](https://www.sitemaps.org/protocol.html).
+priority
+: The priority of a page relative to any other page on the site. Valid values range from 0.0 to 1.0. Default is `-1` (priority omitted from rendered sitemap).
 
-```xml
-{{ printf "<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?>" | safeHTML }}
-<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"
-  xmlns:xhtml="http://www.w3.org/1999/xhtml">
-  {{ range .Data.Pages }}
-  <url>
-    <loc>{{ .Permalink }}</loc>{{ if not .Lastmod.IsZero }}
-    <lastmod>{{ safeHTML ( .Lastmod.Format "2006-01-02T15:04:05-07:00" ) }}</lastmod>{{ end }}{{ with .Sitemap.ChangeFreq }}
-    <changefreq>{{ . }}</changefreq>{{ end }}{{ if ge .Sitemap.Priority 0.0 }}
-    <priority>{{ .Sitemap.Priority }}</priority>{{ end }}{{ if .IsTranslated }}{{ range .Translations }}
-    <xhtml:link
-                rel="alternate"
-                hreflang="{{ .Lang }}"
-                href="{{ .Permalink }}"
-                />{{ end }}
-    <xhtml:link
-                rel="alternate"
-                hreflang="{{ .Lang }}"
-                href="{{ .Permalink }}"
-                />{{ end }}
-  </url>
-  {{ end }}
-</urlset>
-```
+## Override Default Values
 
-## Hugo's sitemapindex.xml
+Override the default values for a given page in front matter.
 
-This is used to create a Sitemap index in multilingual mode:
+{{< code-toggle file="news.md" fm=true >}}
+title = 'News'
+[sitemap]
+  changefreq = 'weekly'
+  priority = 0.8
+{{</ code-toggle >}}
 
-```xml
-{{ printf "<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?>" | safeHTML }}
-<sitemapindex xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
-       {{ range . }}
-       <sitemap>
-               <loc>{{ .SitemapAbsURL }}</loc>
-               {{ if not .LastChange.IsZero }}
-               <lastmod>{{ .LastChange.Format "2006-01-02T15:04:05-07:00" | safeHTML }}</lastmod>
-               {{ end }}
-       </sitemap>
-       {{ end }}
-</sitemapindex>
-```
+## Override Built-in Templates
 
-## Configure `sitemap.xml`
+To override the built-in sitemap.xml template, create a new file in either of these locations:
 
-Defaults for `<changefreq>`, `<priority>` and `filename` values can be set in the site's config file, e.g.:
+- layouts/sitemap.xml
+- layouts/_default/sitemap.xml
 
-{{< code-toggle file="config" >}}
-[sitemap]
-  changefreq = "monthly"
-  priority = 0.5
-  filename = "sitemap.xml"
-{{</ code-toggle >}}
+When ranging through the page collection, access the _change frequency_ and _priority_ with `.Sitemap.ChangeFreq` and `.Sitemap.Priority` respectively.
+
+To override the built-in sitemapindex.xml template, create a new file in either of these locations:
 
-The same fields can be specified in an individual content file's front matter in order to override the value assigned to that piece of content at render time.
+- layouts/sitemapindex.xml
+- layouts/_default/sitemapindex.xml
 
+## Disable Sitemap Generation
 
+You may disable sitemap generation in your site configuration:
+
+{{< code-toggle file="config" >}}
+disableKinds = ['sitemap']
+{{</ code-toggle >}}
 
-[pagevars]: /variables/page/
+[`publishDir`]: {{< relref "getting-started/configuration#publishdir" >}}
+[change frequency]: <https://www.sitemaps.org/protocol.html#changefreqdef>
+[priority]: <https://www.sitemaps.org/protocol.html#priority>
+[sitemap protocol]: <https://www.sitemaps.org/protocol.html>
+[sitemap.xml]: <https://github.com/gohugoio/hugo/blob/master/tpl/tplimpl/embedded/templates/_default/sitemap.xml>
+[sitemapindex.xml]: <https://github.com/gohugoio/hugo/blob/master/tpl/tplimpl/embedded/templates/_default/sitemapindex.xml>
index d87bd4013f32076ab2e716a1492088887572a5c6..7009164ebf8190f3e1865517ce8a45ee3c4185e9 100644 (file)
@@ -4,7 +4,7 @@ linktitle: Migrations
 description: A list of community-developed tools for migrating from your existing static site generator or content management system to Hugo.
 date: 2017-02-01
 publishdate: 2017-02-01
-lastmod: 2017-02-01
+lastmod: 2022-03-26
 keywords: [migrations,jekyll,wordpress,drupal,ghost,contentful]
 menu:
   docs:
@@ -47,9 +47,9 @@ Alternatively, you can use the new [Jekyll import command](/commands/hugo_import
 ## WordPress
 
 - [wordpress-to-hugo-exporter](https://github.com/SchumacherFM/wordpress-to-hugo-exporter) - A one-click WordPress plugin that converts all posts, pages, taxonomies, metadata, and settings to Markdown and YAML which can be dropped into Hugo. (Note: If you have trouble using this plugin, you can [export your site for Jekyll](https://wordpress.org/plugins/jekyll-exporter/) and use Hugo's built in Jekyll converter listed above.)
-- [exitwp-for-hugo](https://github.com/wooni005/exitwp-for-hugo) - A python script which works with the xml export from WordPress and converts WordPress pages and posts to Markdown and YAML for hugo.
 - [blog2md](https://github.com/palaniraja/blog2md) - Works with [exported xml](https://en.support.wordpress.com/export/) file of your free YOUR-TLD.wordpress.com website. It also saves approved comments to `YOUR-POST-NAME-comments.md` file along with posts.
 - [wordhugopress](https://github.com/nantipov/wordhugopress) - A small utility written in Java, exports the entire WordPress site from the database and resource (e.g. images) files stored locally or remotely. Therefore, migration from the backup files is possible. Supports merging of the multiple WordPress sites into a single Hugo one.
+- [wpxr-to-static](https://github.com/danielfdickinson/wpxr-to-static) - WordPress eXtended RSS to Static Generator Conversion, Python3 program to convert WordPress XML Export (WPXR) format files to Hugo Markdown files (with YAML metadata) and a `config.toml` for the site. Inspired by [exitwp-for-hugo](https://github.com/wooni005/exitwp-for-hugo) (a Python 2 \[EOL] script which works with the xml export from WordPress and converts WordPress pages and posts to Markdown and YAML for hugo).
 
 ## Medium
 
index 7f85c6d1a96adc9ba90f684f91d3351ffaa5cabd..2440fc930def6545fd3c8215d36818b415b7b113 100644 (file)
           "Args": [
             "h",
             "k",
-            "m"
+            "m",
+            "e"
           ],
           "Aliases": [
             "hmac"
index 299602318c4c854a1cc752ffbcc5a5199239f22b..2035c058b55d321171899f3fe4c1dcff760b6595 100644 (file)
@@ -15,7 +15,7 @@
         <div class="w-100">
             {{ $byLastMod :=  .Site.RegularPages.ByLastmod  }}
             {{ $recent := ($byLastMod | last 30).Reverse }}
-            {{ $leastRecent := $byLastMod | first 10 }}            
+            {{ $leastRecent := $byLastMod | first 10 }}
             <h2 id="last-updated">Last Updated</h2>
             {{ partial "maintenance-pages-table.html" $recent }}
             <h2 id="least-recently-updated">Least Recently Updated</h2>
index a29dc9ec366d881f106043298de670062ac141de..b97fb55c38aede12840eaad90b525a61d37f35a7 100644 (file)
@@ -3,7 +3,7 @@ publish = "public"
 command = "hugo --gc --minify"
 
 [context.production.environment]
-HUGO_VERSION = "0.95.0"
+HUGO_VERSION = "0.96.0"
 HUGO_ENV = "production"
 HUGO_ENABLEGITINFO = "true"
 
@@ -11,20 +11,20 @@ HUGO_ENABLEGITINFO = "true"
 command = "hugo --gc --minify --enableGitInfo"
 
 [context.split1.environment]
-HUGO_VERSION = "0.95.0"
+HUGO_VERSION = "0.96.0"
 HUGO_ENV = "production"
 
 [context.deploy-preview]
 command = "hugo --gc --minify --buildFuture -b $DEPLOY_PRIME_URL"
 
 [context.deploy-preview.environment]
-HUGO_VERSION = "0.95.0"
+HUGO_VERSION = "0.96.0"
 
 [context.branch-deploy]
 command = "hugo --gc --minify -b $DEPLOY_PRIME_URL"
 
 [context.branch-deploy.environment]
-HUGO_VERSION = "0.95.0"
+HUGO_VERSION = "0.96.0"
 
 [context.next.environment]
 HUGO_ENABLEGITINFO = "true"