From 3a397980b55f587db7c8873802ce46898ed4c409 Mon Sep 17 00:00:00 2001 From: Christian Zei Date: Wed, 23 Jul 2025 14:08:13 +0200 Subject: [PATCH 1/2] Add description for comment shortcode --- .../content/en/docs/adding-content/shortcodes/index.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/userguide/content/en/docs/adding-content/shortcodes/index.md b/userguide/content/en/docs/adding-content/shortcodes/index.md index cc416664d6..57d26b5e30 100644 --- a/userguide/content/en/docs/adding-content/shortcodes/index.md +++ b/userguide/content/en/docs/adding-content/shortcodes/index.md @@ -442,6 +442,16 @@ says "Couldn’t find the X-Frame-Options header in the response headers." you found in the HTTP response headers as highlighted below.", you **CANNOT** - unless it has been explicitly enabled for your site. {{% /alert %}} +### comment + +Use the comment shortcode to add internal notes that won't be shown in the rendered page. + +```go-template +{{< comment >}} +This comment will not be visible in the rendered page. +{{< /comment >}} +``` + ## Tabbed panes Sometimes it's very useful to have tabbed panes when authoring content. One From a54d48101054fa0c4cb6ed4cdb151861b9f49b4e Mon Sep 17 00:00:00 2001 From: Christian Zei Date: Wed, 23 Jul 2025 14:20:15 +0200 Subject: [PATCH 2/2] enhance comment shortcode description --- userguide/content/en/docs/adding-content/shortcodes/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/userguide/content/en/docs/adding-content/shortcodes/index.md b/userguide/content/en/docs/adding-content/shortcodes/index.md index 57d26b5e30..d41e463814 100644 --- a/userguide/content/en/docs/adding-content/shortcodes/index.md +++ b/userguide/content/en/docs/adding-content/shortcodes/index.md @@ -444,7 +444,7 @@ unless it has been explicitly enabled for your site. {{% /alert %}} ### comment -Use the comment shortcode to add internal notes that won't be shown in the rendered page. +Use the `comment` shortcode to add internal notes or comment out large blocks of Markdown or HTML that won't be rendered on the page. ```go-template {{< comment >}}