Skip to content

Add description for comment shortcode #2306

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
adlerzei wants to merge 2 commits into
base: main
Choose a base branch
from
+10 −0
Open

Add description for comment shortcode #2306

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3a39798
Add description for comment shortcode
adlerzei Jul 23, 2025
a54d481
enhance comment shortcode description
adlerzei Jul 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions userguide/content/en/docs/adding-content/shortcodes/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 or comment out large blocks of Markdown or HTML that won't be rendered on the 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
Expand Down