From 8eddffc6ff2cfd1c802245b0aea696a226c50bd7 Mon Sep 17 00:00:00 2001 From: Misty Stanley-Jones Date: Mon, 4 Jun 2018 16:59:54 -0700 Subject: [PATCH] Add figure shortcode example to smoke tests (#8598) --- content/en/docs/test.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/content/en/docs/test.md b/content/en/docs/test.md index 5eee1b889f..2b4fa9569c 100644 --- a/content/en/docs/test.md +++ b/content/en/docs/test.md @@ -162,9 +162,17 @@ image. ![pencil icon](/static/images/pencil.png) -An image can also be a link. This time the pencil icon links to the Kubernetes -website. Outer square brackets enclose the entire image tag, and the link target -is in the parentheses at the end. +To specify extended attributes, such as width, title, caption, etc, use the +figure shortcode, +which is preferred to using a HTML `` tag. Also, if you need the image to +also be a hyperlink, use the `link` attribute, rather than wrapping the whole +figure in Markdown link syntax as shown below. + +{{< figure src="/static/images/pencil.png" title="Pencil icon" caption="Image used to illustrate the figure shortcode" width="200px" >}} + +Even if you choose not to use the figure shortcode, an image can also be a link. This +time the pencil icon links to the Kubernetes website. Outer square brackets enclose +the entire image tag, and the link target is in the parentheses at the end. [![pencil icon](/static/images/pencil.png)](https://kubernetes.io)