From 1985886bd9afe4d42cb309a462edb114be4e9817 Mon Sep 17 00:00:00 2001 From: Joe Mooring Date: Tue, 19 Nov 2024 18:02:30 -0800 Subject: [PATCH] Adjust front matter of shared Markdown snippets --- content/en/content-management/_common/page-kinds.md | 2 +- content/en/functions/_common/glob-patterns.md | 2 +- content/en/functions/_common/go-html-template-package.md | 2 +- content/en/functions/_common/locales.md | 2 +- content/en/functions/_common/regular-expressions.md | 2 +- content/en/functions/_common/time-layout-string.md | 2 +- content/en/functions/fmt/_common/fmt-layout.md | 2 +- content/en/functions/go-template/_common/text-template.md | 2 +- content/en/functions/go-template/_common/truthy-falsy.md | 2 +- content/en/functions/images/_common/apply-image-filter.md | 2 +- .../en/functions/resources/_common/postcss-windows-warning.md | 2 +- content/en/functions/time/_common/parsable-date-time-strings.md | 2 +- content/en/functions/urls/_common/anchorize-vs-urlize.md | 2 +- content/en/installation/_common/01-editions.md | 2 +- content/en/installation/_common/02-prerequisites.md | 2 +- content/en/installation/_common/03-prebuilt-binaries.md | 2 +- content/en/installation/_common/04-build-from-source.md | 2 +- content/en/installation/_common/homebrew.md | 2 +- content/en/methods/menu-entry/_common/pre-post.md | 2 +- content/en/methods/page/_common/definition-of-section.md | 2 +- content/en/methods/page/_common/next-and-prev.md | 2 +- .../en/methods/page/_common/nextinsection-and-previnsection.md | 2 +- content/en/methods/page/_common/output-format-definition.md | 2 +- content/en/methods/page/_common/output-format-methods.md | 2 +- content/en/methods/page/_common/scratch-methods.md | 2 +- content/en/methods/pages/_common/group-sort-order.md | 2 +- content/en/methods/pages/_common/next-and-prev.md | 2 +- .../en/methods/resource/_common/global-page-remote-resources.md | 2 +- content/en/methods/resource/_common/processing-spec.md | 2 +- content/en/methods/taxonomy/_common/get-a-taxonomy-object.md | 2 +- .../taxonomy/_common/ordered-taxonomy-element-methods.md | 2 +- content/en/render-hooks/_common/pageinner.md | 2 +- content/en/templates/_common/filter-sort-group.md | 2 +- 33 files changed, 33 insertions(+), 33 deletions(-) diff --git a/content/en/content-management/_common/page-kinds.md b/content/en/content-management/_common/page-kinds.md index 07a53e8e63..8f10dcd792 100644 --- a/content/en/content-management/_common/page-kinds.md +++ b/content/en/content-management/_common/page-kinds.md @@ -1,5 +1,5 @@ --- -# Do not remove front matter. +_comment: Do not remove front matter. --- | Kind | Description | Example | diff --git a/content/en/functions/_common/glob-patterns.md b/content/en/functions/_common/glob-patterns.md index 3b0813f6fe..d3092dece2 100644 --- a/content/en/functions/_common/glob-patterns.md +++ b/content/en/functions/_common/glob-patterns.md @@ -1,5 +1,5 @@ --- -# Do not remove front matter. +_comment: Do not remove front matter. --- Path|Pattern|Match diff --git a/content/en/functions/_common/go-html-template-package.md b/content/en/functions/_common/go-html-template-package.md index b622f2b76e..57992ea66b 100644 --- a/content/en/functions/_common/go-html-template-package.md +++ b/content/en/functions/_common/go-html-template-package.md @@ -1,5 +1,5 @@ --- -# Do not remove front matter. +_comment: Do not remove front matter. --- Hugo uses Go's [text/template] and [html/template] packages. diff --git a/content/en/functions/_common/locales.md b/content/en/functions/_common/locales.md index fd84157819..42d0087760 100644 --- a/content/en/functions/_common/locales.md +++ b/content/en/functions/_common/locales.md @@ -1,5 +1,5 @@ --- -# Do not remove front matter. +_comment: Do not remove front matter. --- {{% note %}} diff --git a/content/en/functions/_common/regular-expressions.md b/content/en/functions/_common/regular-expressions.md index 48e020ac65..58f81a2ee5 100644 --- a/content/en/functions/_common/regular-expressions.md +++ b/content/en/functions/_common/regular-expressions.md @@ -1,5 +1,5 @@ --- -# Do not remove front matter. +_comment: Do not remove front matter. --- When specifying the regular expression, use a raw [string literal] (backticks) instead of an interpreted string literal (double quotes) to simplify the syntax. With an interpreted string literal you must escape backslashes. diff --git a/content/en/functions/_common/time-layout-string.md b/content/en/functions/_common/time-layout-string.md index 827dc98946..3664eaef2e 100644 --- a/content/en/functions/_common/time-layout-string.md +++ b/content/en/functions/_common/time-layout-string.md @@ -1,5 +1,5 @@ --- -# Do not remove front matter. +_comment: Do not remove front matter. --- Format a `time.Time` value based on [Go's reference time]: diff --git a/content/en/functions/fmt/_common/fmt-layout.md b/content/en/functions/fmt/_common/fmt-layout.md index ff69ce5e43..09a9ee8677 100644 --- a/content/en/functions/fmt/_common/fmt-layout.md +++ b/content/en/functions/fmt/_common/fmt-layout.md @@ -1,5 +1,5 @@ --- -# Do not remove front matter. +_comment: Do not remove front matter. --- The documentation for Go's [fmt] package describes the structure and content of the format string. diff --git a/content/en/functions/go-template/_common/text-template.md b/content/en/functions/go-template/_common/text-template.md index 71718c3fd3..4b934c1e98 100644 --- a/content/en/functions/go-template/_common/text-template.md +++ b/content/en/functions/go-template/_common/text-template.md @@ -1,5 +1,5 @@ --- -# Do not remove front matter. +_comment: Do not remove front matter. --- See Go's [text/template] documentation for more information. diff --git a/content/en/functions/go-template/_common/truthy-falsy.md b/content/en/functions/go-template/_common/truthy-falsy.md index c41bb65618..e15e58d617 100644 --- a/content/en/functions/go-template/_common/truthy-falsy.md +++ b/content/en/functions/go-template/_common/truthy-falsy.md @@ -1,5 +1,5 @@ --- -# Do not remove front matter. +_comment: Do not remove front matter. --- The falsy values are `false`, `0`, any `nil` pointer or interface value, any array, slice, map, or string of length zero, and zero `time.Time` values. diff --git a/content/en/functions/images/_common/apply-image-filter.md b/content/en/functions/images/_common/apply-image-filter.md index 15eddb4854..08e08238f3 100644 --- a/content/en/functions/images/_common/apply-image-filter.md +++ b/content/en/functions/images/_common/apply-image-filter.md @@ -1,5 +1,5 @@ --- -# Do not remove front matter. +_comment: Do not remove front matter. --- Apply the filter using the [`images.Filter`] function: diff --git a/content/en/functions/resources/_common/postcss-windows-warning.md b/content/en/functions/resources/_common/postcss-windows-warning.md index 1b72e74db3..e2d97850b2 100644 --- a/content/en/functions/resources/_common/postcss-windows-warning.md +++ b/content/en/functions/resources/_common/postcss-windows-warning.md @@ -1,5 +1,5 @@ --- -# Do not remove front matter. +_comment: Do not remove front matter. --- If you are a Windows user, and the path to your project contains a space, you must place the PostCSS configuration within the package.json file. See [this example] and issue [#7333]. diff --git a/content/en/functions/time/_common/parsable-date-time-strings.md b/content/en/functions/time/_common/parsable-date-time-strings.md index 6d1633a6f4..92842767ea 100644 --- a/content/en/functions/time/_common/parsable-date-time-strings.md +++ b/content/en/functions/time/_common/parsable-date-time-strings.md @@ -1,5 +1,5 @@ --- -# Do not remove front matter. +_comment: Do not remove front matter. --- Format|Time zone diff --git a/content/en/functions/urls/_common/anchorize-vs-urlize.md b/content/en/functions/urls/_common/anchorize-vs-urlize.md index 718c140988..710a3c5924 100644 --- a/content/en/functions/urls/_common/anchorize-vs-urlize.md +++ b/content/en/functions/urls/_common/anchorize-vs-urlize.md @@ -1,5 +1,5 @@ --- -# Do not remove front matter. +_comment: Do not remove front matter. --- The [`anchorize`] and [`urlize`] functions are similar: diff --git a/content/en/installation/_common/01-editions.md b/content/en/installation/_common/01-editions.md index 7a80a522e5..b6fc23c74e 100644 --- a/content/en/installation/_common/01-editions.md +++ b/content/en/installation/_common/01-editions.md @@ -1,5 +1,5 @@ --- -# Do not remove front matter. +_comment: Do not remove front matter. --- Hugo is available in three editions: standard, extended, and extended/deploy. While the standard edition provides core functionality, the extended and extended/deploy editions offer advanced features. diff --git a/content/en/installation/_common/02-prerequisites.md b/content/en/installation/_common/02-prerequisites.md index ea6eaa8fe4..65ec2a12f2 100644 --- a/content/en/installation/_common/02-prerequisites.md +++ b/content/en/installation/_common/02-prerequisites.md @@ -1,5 +1,5 @@ --- -# Do not remove front matter. +_comment: Do not remove front matter. --- ## Prerequisites diff --git a/content/en/installation/_common/03-prebuilt-binaries.md b/content/en/installation/_common/03-prebuilt-binaries.md index 55f7cb85bd..34411cddd1 100644 --- a/content/en/installation/_common/03-prebuilt-binaries.md +++ b/content/en/installation/_common/03-prebuilt-binaries.md @@ -1,5 +1,5 @@ --- -# Do not remove front matter. +_comment: Do not remove front matter. --- ## Prebuilt binaries diff --git a/content/en/installation/_common/04-build-from-source.md b/content/en/installation/_common/04-build-from-source.md index 6829c50ce1..b3039d18ae 100644 --- a/content/en/installation/_common/04-build-from-source.md +++ b/content/en/installation/_common/04-build-from-source.md @@ -1,5 +1,5 @@ --- -# Do not remove front matter. +_comment: Do not remove front matter. --- ## Build from source diff --git a/content/en/installation/_common/homebrew.md b/content/en/installation/_common/homebrew.md index 6cd7a524fd..14f48174ef 100644 --- a/content/en/installation/_common/homebrew.md +++ b/content/en/installation/_common/homebrew.md @@ -1,5 +1,5 @@ --- -# Do not remove front matter. +_comment: Do not remove front matter. --- ### Homebrew diff --git a/content/en/methods/menu-entry/_common/pre-post.md b/content/en/methods/menu-entry/_common/pre-post.md index fbfce062a5..da3d584d17 100644 --- a/content/en/methods/menu-entry/_common/pre-post.md +++ b/content/en/methods/menu-entry/_common/pre-post.md @@ -1,5 +1,5 @@ --- -# Do not remove front matter. +_comment: Do not remove front matter. --- In this site configuration we enable rendering of [emoji shortcodes], and add emoji shortcodes before (pre) and after (post) each menu entry: diff --git a/content/en/methods/page/_common/definition-of-section.md b/content/en/methods/page/_common/definition-of-section.md index 7dc6007893..79e22b10db 100644 --- a/content/en/methods/page/_common/definition-of-section.md +++ b/content/en/methods/page/_common/definition-of-section.md @@ -1,5 +1,5 @@ --- -# Do not remove front matter. +_comment: Do not remove front matter. --- A _section_ is a top-level content directory, or any content directory with an _index.md file. diff --git a/content/en/methods/page/_common/next-and-prev.md b/content/en/methods/page/_common/next-and-prev.md index 0d1436e11f..c71392c8fc 100644 --- a/content/en/methods/page/_common/next-and-prev.md +++ b/content/en/methods/page/_common/next-and-prev.md @@ -1,5 +1,5 @@ --- -# Do not remove front matter. +_comment: Do not remove front matter. --- Hugo determines the _next_ and _previous_ page by sorting the site's collection of regular pages according to this sorting hierarchy: diff --git a/content/en/methods/page/_common/nextinsection-and-previnsection.md b/content/en/methods/page/_common/nextinsection-and-previnsection.md index 6c558b69ed..f2126eaeed 100644 --- a/content/en/methods/page/_common/nextinsection-and-previnsection.md +++ b/content/en/methods/page/_common/nextinsection-and-previnsection.md @@ -1,5 +1,5 @@ --- -# Do not remove front matter. +_comment: Do not remove front matter. --- Hugo determines the _next_ and _previous_ page by sorting the current section's regular pages according to this sorting hierarchy: diff --git a/content/en/methods/page/_common/output-format-definition.md b/content/en/methods/page/_common/output-format-definition.md index d21211a3d8..df89447f73 100644 --- a/content/en/methods/page/_common/output-format-definition.md +++ b/content/en/methods/page/_common/output-format-definition.md @@ -1,5 +1,5 @@ --- -# Do not remove front matter. +_comment: Do not remove front matter. --- Hugo generates one or more files per page when building a site. For example, when rendering home, [section], [taxonomy], and [term] pages, Hugo generates an HTML file and an RSS file. Both HTML and RSS are built-in _output formats_. Create multiple output formats, and control generation based on [page kind], or by enabling one or more output formats for one or more pages. See [details]. diff --git a/content/en/methods/page/_common/output-format-methods.md b/content/en/methods/page/_common/output-format-methods.md index 5e7111fe52..5390e7b465 100644 --- a/content/en/methods/page/_common/output-format-methods.md +++ b/content/en/methods/page/_common/output-format-methods.md @@ -1,5 +1,5 @@ --- -# Do not remove front matter. +_comment: Do not remove front matter. --- Get IDENTIFIER diff --git a/content/en/methods/page/_common/scratch-methods.md b/content/en/methods/page/_common/scratch-methods.md index b2650cddef..92a97cdd51 100644 --- a/content/en/methods/page/_common/scratch-methods.md +++ b/content/en/methods/page/_common/scratch-methods.md @@ -1,5 +1,5 @@ --- -# Do not remove front matter. +_comment: Do not remove front matter. --- ## Methods diff --git a/content/en/methods/pages/_common/group-sort-order.md b/content/en/methods/pages/_common/group-sort-order.md index bb5be82f6c..e2997a1bd2 100644 --- a/content/en/methods/pages/_common/group-sort-order.md +++ b/content/en/methods/pages/_common/group-sort-order.md @@ -1,5 +1,5 @@ --- -# Do not remove front matter. +_comment: Do not remove front matter. --- For the optional sort order, specify either `asc` for ascending order, or `desc` for descending order. diff --git a/content/en/methods/pages/_common/next-and-prev.md b/content/en/methods/pages/_common/next-and-prev.md index e0d05de845..5407839927 100644 --- a/content/en/methods/pages/_common/next-and-prev.md +++ b/content/en/methods/pages/_common/next-and-prev.md @@ -1,5 +1,5 @@ --- -# Do not remove front matter. +_comment: Do not remove front matter. --- Hugo determines the _next_ and _previous_ page by sorting the page collection according to this sorting hierarchy: diff --git a/content/en/methods/resource/_common/global-page-remote-resources.md b/content/en/methods/resource/_common/global-page-remote-resources.md index 4ea4d1b874..5df2963e39 100644 --- a/content/en/methods/resource/_common/global-page-remote-resources.md +++ b/content/en/methods/resource/_common/global-page-remote-resources.md @@ -1,5 +1,5 @@ --- -# Do not remove front matter. +_comment: Do not remove front matter. --- {{% note %}} diff --git a/content/en/methods/resource/_common/processing-spec.md b/content/en/methods/resource/_common/processing-spec.md index b12a21d3a6..395217328e 100644 --- a/content/en/methods/resource/_common/processing-spec.md +++ b/content/en/methods/resource/_common/processing-spec.md @@ -1,5 +1,5 @@ --- -# Do not remove front matter. +_comment: Do not remove front matter. --- ## Process specification diff --git a/content/en/methods/taxonomy/_common/get-a-taxonomy-object.md b/content/en/methods/taxonomy/_common/get-a-taxonomy-object.md index ef78c8eaeb..928ec085aa 100644 --- a/content/en/methods/taxonomy/_common/get-a-taxonomy-object.md +++ b/content/en/methods/taxonomy/_common/get-a-taxonomy-object.md @@ -1,5 +1,5 @@ --- -# Do not remove front matter. +_comment: Do not remove front matter. --- Before we can use a `Taxonomy` method, we need to capture a `Taxonomy` object. diff --git a/content/en/methods/taxonomy/_common/ordered-taxonomy-element-methods.md b/content/en/methods/taxonomy/_common/ordered-taxonomy-element-methods.md index 7201ad3188..a23c26ef54 100644 --- a/content/en/methods/taxonomy/_common/ordered-taxonomy-element-methods.md +++ b/content/en/methods/taxonomy/_common/ordered-taxonomy-element-methods.md @@ -1,5 +1,5 @@ --- -# Do not remove front matter. +_comment: Do not remove front matter. --- An ordered taxonomy is a slice, where each element is an object that contains the term and a slice of its weighted pages. diff --git a/content/en/render-hooks/_common/pageinner.md b/content/en/render-hooks/_common/pageinner.md index de1316cbab..1d467aeefe 100644 --- a/content/en/render-hooks/_common/pageinner.md +++ b/content/en/render-hooks/_common/pageinner.md @@ -1,5 +1,5 @@ --- -# Do not remove front matter. +_comment: Do not remove front matter. --- ## PageInner details diff --git a/content/en/templates/_common/filter-sort-group.md b/content/en/templates/_common/filter-sort-group.md index 89cc095f5f..24bbee96ea 100644 --- a/content/en/templates/_common/filter-sort-group.md +++ b/content/en/templates/_common/filter-sort-group.md @@ -1,5 +1,5 @@ --- -# Do not remove front matter. +_comment: Do not remove front matter. --- {{% note %}}