diff options
author | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2025-02-13 10:40:34 +0100 |
---|---|---|
committer | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2025-02-13 10:40:34 +0100 |
commit | 304a7e5e7439a8a45449623057cad790c6053e4d (patch) | |
tree | e908df0152da0fc0d8f63f979e3cd8570edeab6e /docs/content/en/shortcodes/gist.md | |
parent | c054e18827aee0f2d8b90ae1ece093f4321478a4 (diff) | |
parent | a024bc7d76fcc5e49e8210f9b0896db9ef21861a (diff) | |
download | hugo-304a7e5e7439a8a45449623057cad790c6053e4d.tar.gz hugo-304a7e5e7439a8a45449623057cad790c6053e4d.zip |
Merge commit 'a024bc7d76fcc5e49e8210f9b0896db9ef21861a'
Diffstat (limited to 'docs/content/en/shortcodes/gist.md')
-rwxr-xr-x | docs/content/en/shortcodes/gist.md | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/docs/content/en/shortcodes/gist.md b/docs/content/en/shortcodes/gist.md index dc85f282c..1c740bccb 100755 --- a/docs/content/en/shortcodes/gist.md +++ b/docs/content/en/shortcodes/gist.md @@ -8,13 +8,19 @@ menu: parent: shortcodes weight: weight: +expiryDate: 2027-02-01 # deprecated 2025-02-01 in v0.143.0 --- -{{% note %}} -To override Hugo's embedded `gist` shortcode, copy the [source code] to a file with the same name in the `layouts/shortcodes` directory. +{{% deprecated-in 0.143.0 %}} +The `gist` shortcode was deprecated in version 0.143.0 and will be removed in a future release. To continue embedding GitHub Gists in your content, you'll need to create a custom shortcode: -[source code]: {{% eturl gist %}} -{{% /note %}} +1. Create a new file: Create a file named `gist.html` within the `layouts/shortcodes` directory. +2. Copy the source code: Paste the [original source code] of the gist shortcode into the newly created `gist.html` file. + +This will allow you to maintain the functionality of embedding GitHub Gists in your content after the deprecation of the original shortcode. + +[original source code]: {{% eturl gist %}} +{{% /deprecated-in %}} To display a GitHub gist with this URL: @@ -28,14 +34,8 @@ Include this in your Markdown: {{</* gist user 23932424365401ffa5e9d9810102a477 */>}} ``` -This will display all files in the gist alphabetically by file name. - -{{< gist jmooring 23932424365401ffa5e9d9810102a477 >}} - To display a specific file within the gist: ```text {{</* gist user 23932424365401ffa5e9d9810102a477 list.html */>}} ``` - -{{< gist jmooring 23932424365401ffa5e9d9810102a477 list.html >}} |