From 0ca7ccd30460dcb890ecf75a14eb7724592a1afb Mon Sep 17 00:00:00 2001 From: Joe Mooring Date: Wed, 22 Jan 2025 08:19:17 -0800 Subject: [PATCH] Replace usage of comment shortcode with HTML comments --- archetypes/glossary.md | 4 ++-- content/en/content-management/front-matter.md | 4 ---- content/en/content-management/summaries.md | 4 ++-- content/en/functions/transform/ToMath.md | 4 ---- content/en/getting-started/glossary/logical-path.md | 2 +- content/en/methods/page/Summary.md | 7 +++---- content/en/methods/site/Taxonomies.md | 4 ---- content/en/quick-reference/emojis.md | 4 ++-- 8 files changed, 10 insertions(+), 23 deletions(-) diff --git a/archetypes/glossary.md b/archetypes/glossary.md index 1a060ee98..b38ced64a 100644 --- a/archetypes/glossary.md +++ b/archetypes/glossary.md @@ -2,7 +2,7 @@ title: {{ replace .File.ContentBaseName "-" " " }} --- -{{% comment %}} + diff --git a/content/en/content-management/front-matter.md b/content/en/content-management/front-matter.md index 8a2e589d1..dba77f1d1 100644 --- a/content/en/content-management/front-matter.md +++ b/content/en/content-management/front-matter.md @@ -117,7 +117,6 @@ If `true`, the page will not be rendered unless you pass the `--buildDrafts` fla [`keywords`]: /methods/page/keywords/ -{{% comment %}} -{{% /comment %}} ###### lastmod @@ -173,13 +171,11 @@ Alias to [lastmod](#lastmod). [output formats]: /templates/output-formats/ -{{% comment %}} -{{% /comment %}} ###### params diff --git a/content/en/content-management/summaries.md b/content/en/content-management/summaries.md index 07c61d963..dbe8ff248 100644 --- a/content/en/content-management/summaries.md +++ b/content/en/content-management/summaries.md @@ -12,10 +12,10 @@ weight: 160 toc: true aliases: [/content/summaries/,/content-management/content-summaries/] --- -{{% comment %}} + -{{% /comment %}} + You can define a summary manually, in front matter, or automatically. A manual summary takes precedence over a front matter summary, and a front matter summary takes precedence over an automatic summary. diff --git a/content/en/functions/transform/ToMath.md b/content/en/functions/transform/ToMath.md index 043563862..62d1360ce 100644 --- a/content/en/functions/transform/ToMath.md +++ b/content/en/functions/transform/ToMath.md @@ -57,8 +57,6 @@ fleqn macros : (`map`) A map of macros to be used in the math expression. Default is `{}`. - {{% comment %}}Indent to prevent splitting the description list.{{% / comment %}} - ```go-html-template {{ $macros := dict "\\addBar" "\\bar{#1}" @@ -74,8 +72,6 @@ minRuleThickness output : (`string`). Determines the markup language of the output, one of `html`, `mathml`, or `htmlAndMathml`. Default is `mathml`. - {{% comment %}}Indent to prevent splitting the description list.{{% / comment %}} - With `html` and `htmlAndMathml` you must include the KaTeX style sheet within the `head` element of your base template. ```html diff --git a/content/en/getting-started/glossary/logical-path.md b/content/en/getting-started/glossary/logical-path.md index 5e888757d..3a2c96f18 100644 --- a/content/en/getting-started/glossary/logical-path.md +++ b/content/en/getting-started/glossary/logical-path.md @@ -4,4 +4,4 @@ title: logical path {{< new-in 0.123.0 >}} -A page or page resource identifier derived from the file path, excluding its extension and language identifier. This value is neither a file path nor a URL. Starting with a file path relative to the `content` directory, Hugo determines the logical path by stripping the file extension and language identifier, converting to lower case, then replacing spaces with hyphens. {{% comment %}}{{% /comment %}} See [examples](/methods/page/path/#examples). +A page or page resource identifier derived from the file path, excluding its extension and language identifier. This value is neither a file path nor a URL. Starting with a file path relative to the `content` directory, Hugo determines the logical path by stripping the file extension and language identifier, converting to lower case, then replacing spaces with hyphens. See [examples](/methods/page/path/#examples). diff --git a/content/en/methods/page/Summary.md b/content/en/methods/page/Summary.md index 490b201d0..a875d62f0 100644 --- a/content/en/methods/page/Summary.md +++ b/content/en/methods/page/Summary.md @@ -13,10 +13,9 @@ action: signatures: [PAGE.Summary] --- -{{% comment %}} -Do not remove the manual summary divider below. -If you do, you will break its first literal usage on this page. -{{% /comment %}} + + + You can define a [summary] manually, in front matter, or automatically. A manual summary takes precedence over a front matter summary, and a front matter summary takes precedence over an automatic summary. diff --git a/content/en/methods/site/Taxonomies.md b/content/en/methods/site/Taxonomies.md index 75ddb7a3b..ee98d2ac5 100644 --- a/content/en/methods/site/Taxonomies.md +++ b/content/en/methods/site/Taxonomies.md @@ -9,10 +9,6 @@ action: signatures: [SITE.Taxonomies] --- -{{% comment %}} -Show template example: GetTerms -{{% /comment %}} - Conceptually, the `Taxonomies` method on a `Site` object returns a data structure such as: {{< code-toggle >}} diff --git a/content/en/quick-reference/emojis.md b/content/en/quick-reference/emojis.md index d2e73843f..946a49069 100644 --- a/content/en/quick-reference/emojis.md +++ b/content/en/quick-reference/emojis.md @@ -53,7 +53,7 @@ To process an emoji shortcode from within a template, use the [`emojify`] functi [`emojify`]: /functions/transform/emojify/ [`RenderString`]: /methods/page/renderstring/ -{{% comment %}} + ## Table of Contents