Skip to content

Commit 5fb97e5

Browse files
authored
mermaid shortcode mentioned in Note causes error
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.
1 parent 5036a1e commit 5fb97e5

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

content/en/docs/contribute/style/diagram-guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@ Figure 17. A to B
242242
more text
243243
```
244244
{{< note >}}
245-
You must include the `{{</* mermaid */>}}`, `{{</* /mermaid */>}}` shortcode
245+
You must include the Hugo Mermaid shortcode
246246
tags at the start and end of the Mermaid code block. You should add a diagram
247247
caption below the diagram.
248248
{{< /note >}}
@@ -429,7 +429,7 @@ Don't forget to check that your diagram renders correctly using the
429429
This section shows several examples of Mermaid diagrams.
430430

431431
{{< note >}}
432-
The code block examples omit the Hugo `{{</* mermaid */>}}`, `{{</* /mermaid */>}}`
432+
The code block examples omit the Hugo Mermaid
433433
shortcode tags. This allows you to copy the code block into the live editor
434434
to experiment on your own.
435435
Note that the live editor doesn't recognize Hugo shortcodes.

0 commit comments

Comments
 (0)