diff options
Diffstat (limited to 'themes/hugo-book/exampleSite/content.en/docs/shortcodes/images.md')
| -rw-r--r-- | themes/hugo-book/exampleSite/content.en/docs/shortcodes/images.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/themes/hugo-book/exampleSite/content.en/docs/shortcodes/images.md b/themes/hugo-book/exampleSite/content.en/docs/shortcodes/images.md new file mode 100644 index 0000000..72f424f --- /dev/null +++ b/themes/hugo-book/exampleSite/content.en/docs/shortcodes/images.md @@ -0,0 +1,30 @@ +# Images + +Image shortcode produces an image that can be clicked to expand. + +## Example + +```go-html-template +{{</* image src="placeholder.svg" alt="A placeholder" title="A placeholder" loading="lazy" */>}} +``` +{{< image src="placeholder.svg" alt="A placeholder" title="A placeholder" loading="lazy" >}} + +## Parameters + +`src` {{< badge style="warning" title="Required" >}} +: The link to the image + +`class` {{< badge style="info" title="Optional" >}} +: An optional CSS class name that will be applied to the `img` element + +`alt` {{< badge style="info" title="Optional" >}} +: An optional alternate text for the image + +`title` {{< badge style="info" title="Optional" >}} +: An optional title for the image + +`loading` {{< badge style="info" title="Optional" >}} +: Sets `loading` control for the image: `lazy`, `eager` or `auto` + + + |