diff --git a/CHANGELOG.md b/CHANGELOG.md index 68e064c..e5fe9a2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,7 +8,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), ### Added -- New icon for 'kofi' ([#976](https://github.com/jpanther/congo/pull/976)) +- New `gist` shortcode as the built-in Hugo version has been deprecated +- New icon for `kofi` ([#976](https://github.com/jpanther/congo/pull/976)) ### Changed diff --git a/exampleSite/content/docs/shortcodes/index.md b/exampleSite/content/docs/shortcodes/index.md index bd58e56..02e4844 100644 --- a/exampleSite/content/docs/shortcodes/index.md +++ b/exampleSite/content/docs/shortcodes/index.md @@ -155,6 +155,18 @@ Congo also supports automatic conversion of images included using standard Markd {{< figure src="abstract.jpg" alt="Abstract purple artwork" caption="Photo by [Jr Korpa](https://unsplash.com/@jrkorpa) on [Unsplash](https://unsplash.com/)" >}} +## Gist + +The `gist` shortcode can be used to embed a GitHub Gist. It requires two unnamed parameters: the username and ID of the Gist. + +**Example:** + +```md +{{}} +``` + +{{< gist jpanther 26292111fe1eb8e31c60f6dbfef9df28 >}} + ## Icon `icon` outputs an SVG icon and takes the icon name as its only parameter. The icon is scaled to match the current text size. diff --git a/layouts/shortcodes/gist.html b/layouts/shortcodes/gist.html new file mode 100644 index 0000000..3dec2a0 --- /dev/null +++ b/layouts/shortcodes/gist.html @@ -0,0 +1 @@ + \ No newline at end of file