TheCloud/hugoDocs
1
0
Fork 0
mirror of https://github.com/gohugoio/hugoDocs.git synced 2025-09-10 14:34:42 -04:00
Code Issues Packages Projects Releases Wiki Activity

Document the comment shortcode

Browse Source
This commit is contained in:
Joe Mooring 2024-11-05 05:23:03 -08:00 committed by GitHub
parent 83d7d3005a
commit 109efe3ebb
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
content/en/content-management/shortcodes.md
View File

@ -74,6 +74,26 @@ You can call shortcodes within other shortcodes by creating your own templates t
Use these embedded shortcodes as needed. Use these embedded shortcodes as needed.
### comment
{{< new-in "0.137.1" >}}
{{% note %}}
To override Hugo's embedded `comment` shortcode, copy the [source code] to a file with the same name in the layouts/shortcodes directory.
[source code]: {{% eturl comment %}}
{{% /note %}}
Use the `comment` shortcode to include comments in your Markdown. Hugo excludes the encapsulated text when rendering your site.
Example usage:
```text
{{%/* comment */%}} TODO: rewrite the paragraph below. {{%/* /comment */%}}
```
Although you can call this shortcode using the `{{</* */>}}` notation, computationally it is more efficient to call it using the `{{%/* */%}}` notation as shown above.
### figure ### figure
{{% note %}} {{% note %}}

1
data/embedded_template_urls.toml
View File

@ -24,6 +24,7 @@
'render-codeblock-goat' = '_default/_markup/render-codeblock-goat.html' 'render-codeblock-goat' = '_default/_markup/render-codeblock-goat.html'
# Shortcodes # Shortcodes
'comment' = 'shortcodes/comment.html'
'figure' = 'shortcodes/figure.html' 'figure' = 'shortcodes/figure.html'
'gist' = 'shortcodes/gist.html' 'gist' = 'shortcodes/gist.html'
'highlight' = 'shortcodes/highlight.html' 'highlight' = 'shortcodes/highlight.html'