Skip to content

Commit

Permalink
tpl/tplimpl: Deprecate gist shortcode
Browse files Browse the repository at this point in the history
Closes #13211
  • Loading branch information
jmooring authored and bep committed Jan 23, 2025
1 parent a563783 commit f42a4b6
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 0 deletions.
1 change: 1 addition & 0 deletions tpl/tplimpl/embedded/templates/shortcodes/gist.html
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
{{- warnf "The %q shortcode was deprecated in v0.143.0 and will be removed in a future release. See https://gohugo.io/shortcodes/gist for instructions to create a replacement." .Name -}}
<script src="https://gist.github.com/{{ index .Params 0 }}/{{ index .Params 1 }}.js{{if len .Params | eq 3 }}?file={{ index .Params 2 }}{{end}}"></script>
23 changes: 23 additions & 0 deletions tpl/tplimpl/shortcodes_integration_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ disableKinds = ['page','rss','section','sitemap','taxonomy','term']
-- layouts/index.html --
{{ .Content }}
-- content/_index.md --
---
title: home
---
a{{< comment >}}b{{< /comment >}}c
`

Expand Down Expand Up @@ -87,6 +90,26 @@ E: An _emphasized_ word.
)
}

func TestGistShortcode(t *testing.T) {
t.Parallel()

files := `
-- hugo.toml --
disableKinds = ['page','rss','section','sitemap','taxonomy','term']
-- layouts/index.html --
{{ .Content }}
-- content/_index.md --
---
title: home
---
{{< gist jmooring 23932424365401ffa5e9d9810102a477 >}}
`

b := hugolib.Test(t, files, hugolib.TestOptWarn())
b.AssertFileContent("public/index.html", `<script src="https://gist.github.com/jmooring/23932424365401ffa5e9d9810102a477.js"></script>`)
b.AssertLogContains(`WARN The "gist" shortcode was deprecated in v0.143.0 and will be removed in a future release. See https://gohugo.io/shortcodes/gist for instructions to create a replacement.`)
}

func TestInstagramShortcode(t *testing.T) {
t.Parallel()

Expand Down

0 comments on commit f42a4b6

Please sign in to comment.