whentimeslows/website
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

mermaid shortcode mentioned in Note causes error

Browse Source 
Couple of Notes in the [Diagram Guide](https://kubernetes.io/docs/contribute/style/diagram-guide/) include mention of the Hugo Mermaid shortcode. This generates a syntax error. Appears that Hugo interprets this as a Mermaid diagram.

```
{{< note >}}
You must include the `{{</*  mermaid */>}}`, `{{</* /mermaid */>}}` shortcode
tags at the start and end of the Mermaid code block. You should add a diagram
caption below the diagram. 
{{< /note >}}

```

This PR removes the `{{< mermaid >}}` mention inside the `{{< note >}} so that Hugo does not attempt to render a diagram.
This commit is contained in:
chrismetz09
2022-06-28 11:19:41 -07:00
committed by GitHub
parent 5036a1e7f6
commit 5fb97e57a4
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
content/en/docs/contribute/style/diagram-guide.md
+2 -2
View File
@@ -242,7 +242,7 @@ Figure 17. A to B
more text more text
``` ```
{{< note >}} {{< note >}}
You must include the `{{</* mermaid */>}}`, `{{</* /mermaid */>}}` shortcode You must include the Hugo Mermaid shortcode
tags at the start and end of the Mermaid code block. You should add a diagram tags at the start and end of the Mermaid code block. You should add a diagram
caption below the diagram. caption below the diagram.
{{< /note >}} {{< /note >}}
@@ -429,7 +429,7 @@ Don't forget to check that your diagram renders correctly using the
This section shows several examples of Mermaid diagrams. This section shows several examples of Mermaid diagrams.
{{< note >}} {{< note >}}
The code block examples omit the Hugo `{{</* mermaid */>}}`, `{{</* /mermaid */>}}` The code block examples omit the Hugo Mermaid
shortcode tags. This allows you to copy the code block into the live editor shortcode tags. This allows you to copy the code block into the live editor
to experiment on your own. to experiment on your own.
Note that the live editor doesn't recognize Hugo shortcodes. Note that the live editor doesn't recognize Hugo shortcodes.