Replace usage of comment shortcode with HTML comments

This commit is contained in:
Joe Mooring
2025-01-22 08:19:17 -08:00
committed by GitHub
parent fe10d9899d
commit 0ca7ccd304
8 changed files with 10 additions and 23 deletions
+2 -2
View File
@@ -2,7 +2,7 @@
title: {{ replace .File.ContentBaseName "-" " " }} title: {{ replace .File.ContentBaseName "-" " " }}
--- ---
{{% comment %}} <!--
You can insert these definitions in other pages using the `glossary-term` shortcode, so they must be self-contained. You can insert these definitions in other pages using the `glossary-term` shortcode, so they must be self-contained.
Do this: Do this:
@@ -16,4 +16,4 @@ Not this:
Italicize the term whenever you use it in the definition. Italicize the term whenever you use it in the definition.
An exception to this rule occurs when a term is an alias for another. In such cases, it is sufficient to use the phrase 'See [page kind]'." An exception to this rule occurs when a term is an alias for another. In such cases, it is sufficient to use the phrase 'See [page kind]'."
{{% /comment %}} -->
@@ -117,7 +117,6 @@ If `true`, the page will not be rendered unless you pass the `--buildDrafts` fla
[`keywords`]: /methods/page/keywords/ [`keywords`]: /methods/page/keywords/
{{% comment %}}
<!-- Added in v0.123.0 but purposefully omitted from documentation. --> <!-- Added in v0.123.0 but purposefully omitted from documentation. -->
<!-- <!--
kind kind
@@ -129,7 +128,6 @@ kind
lang lang
: The language code for this page. This is usually derived from the module mount or filename. : The language code for this page. This is usually derived from the module mount or filename.
--> -->
{{% /comment %}}
###### lastmod ###### lastmod
@@ -173,13 +171,11 @@ Alias to [lastmod](#lastmod).
[output formats]: /templates/output-formats/ [output formats]: /templates/output-formats/
{{% comment %}}
<!-- Added in v0.123.0 but purposefully omitted from documentation. --> <!-- Added in v0.123.0 but purposefully omitted from documentation. -->
<!-- <!--
path path
: The canonical page path. : The canonical page path.
--> -->
{{% /comment %}}
###### params ###### params
+2 -2
View File
@@ -12,10 +12,10 @@ weight: 160
toc: true toc: true
aliases: [/content/summaries/,/content-management/content-summaries/] aliases: [/content/summaries/,/content-management/content-summaries/]
--- ---
{{% comment %}}
<!-- Do not remove the manual summary divider below. --> <!-- Do not remove the manual summary divider below. -->
<!-- If you do, you will break its first literal usage on this page. --> <!-- If you do, you will break its first literal usage on this page. -->
{{% /comment %}}
<!--more--> <!--more-->
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. 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.
-4
View File
@@ -57,8 +57,6 @@ fleqn
macros macros
: (`map`) A map of macros to be used in the math expression. Default is `{}`. : (`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 ```go-html-template
{{ $macros := dict {{ $macros := dict
"\\addBar" "\\bar{#1}" "\\addBar" "\\bar{#1}"
@@ -74,8 +72,6 @@ minRuleThickness
output output
: (`string`). Determines the markup language of the output, one of `html`, `mathml`, or `htmlAndMathml`. Default is `mathml`. : (`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. With `html` and `htmlAndMathml` you must include the KaTeX style sheet within the `head` element of your base template.
```html ```html
@@ -4,4 +4,4 @@ title: logical path
{{< new-in 0.123.0 >}} {{< 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 %}}<!-- You may also set this value using the `path` front matter field. -->{{% /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).
+3 -4
View File
@@ -13,10 +13,9 @@ action:
signatures: [PAGE.Summary] signatures: [PAGE.Summary]
--- ---
{{% comment %}} <!-- Do not remove the manual summary divider below. -->
Do not remove the manual summary divider below. <!-- If you do, you will break its first literal usage on this page. -->
If you do, you will break its first literal usage on this page.
{{% /comment %}}
<!--more--> <!--more-->
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. 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.
-4
View File
@@ -9,10 +9,6 @@ action:
signatures: [SITE.Taxonomies] signatures: [SITE.Taxonomies]
--- ---
{{% comment %}}
Show template example: GetTerms
{{% /comment %}}
Conceptually, the `Taxonomies` method on a `Site` object returns a data structure such&nbsp;as: Conceptually, the `Taxonomies` method on a `Site` object returns a data structure such&nbsp;as:
{{< code-toggle >}} {{< code-toggle >}}
+2 -2
View File
@@ -53,7 +53,7 @@ To process an emoji shortcode from within a template, use the [`emojify`] functi
[`emojify`]: /functions/transform/emojify/ [`emojify`]: /functions/transform/emojify/
[`RenderString`]: /methods/page/renderstring/ [`RenderString`]: /methods/page/renderstring/
{{% comment %}} <!--
To generate the sections below: To generate the sections below:
git clone https://github.com/ikatyang/emoji-cheat-sheet git clone https://github.com/ikatyang/emoji-cheat-sheet
@@ -67,7 +67,7 @@ Then...
2. Search/replace (regex) "^###\s" with "## " 2. Search/replace (regex) "^###\s" with "## "
3. Search/replace "^####\s " with "### " 3. Search/replace "^####\s " with "### "
4. Search/replace (regex) "<br />" "" 4. Search/replace (regex) "<br />" ""
{{% /comment %}} -->
## Table of Contents ## Table of Contents