From c2db5d12d1fff9de4ae4cd8aec2eb02058c70fc5 Mon Sep 17 00:00:00 2001 From: windsonsea Date: Wed, 15 Jan 2025 10:48:11 +0800 Subject: [PATCH] Fix figure shortcode rendering failed in a note of diagram-guide --- content/en/docs/contribute/style/diagram-guide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/docs/contribute/style/diagram-guide.md b/content/en/docs/contribute/style/diagram-guide.md index 46f941ecec..04f9ec92db 100644 --- a/content/en/docs/contribute/style/diagram-guide.md +++ b/content/en/docs/contribute/style/diagram-guide.md @@ -325,7 +325,7 @@ the `.svg` image file and add a caption. For more details on diagram captions, see [How to use captions](#how-to-use-captions). {{< note >}} -The `{{}}` shortcode is the preferred method for adding `.svg` image files +The figure shortcode is the preferred method for adding `.svg` image files to your documentation. You can also use the standard markdown image syntax like so: `![my boxnet diagram](static/images/boxnet.svg)`. And you will need to add a caption below the diagram. @@ -658,7 +658,7 @@ You should pass the `src`, `alt`, `class` and `caption` values into the `diagram-large`, `diagram-medium` and `diagram-small` classes. {{< note >}} -Diagrams created using the `Inline` method don't use the `{{}}` +Diagrams created using the `Inline` method don't use the figure shortcode. The Mermaid code defines how the diagram will render on your page. {{< /note >}}