fix: escape curly brackets when rendering markdown field doc (#81)

Signed-off-by: Rémi BUISSON <remi-buisson@orange.fr>
elastic · Jul 22, 2024 · 1c93a29 · 1c93a29
1 parent ea9fcaa
commit 1c93a29
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/renderer/markdown.go b/renderer/markdown.go
@@ -145,6 +145,10 @@ func (m *MarkdownRenderer) RenderFieldDoc(text string) string {
 	// so that including | in a comment does not result in wonky tables.
 	out := strings.ReplaceAll(text, "|", "\\|")
 
+	// Escape the curly bracket character.
+	out = strings.ReplaceAll(out, "{", "\\{")
+	out = strings.ReplaceAll(out, "}", "\\}")
+
 	// Replace newlines with 1 line break so that they don't break the Markdown table formatting.
 	out = strings.ReplaceAll(out, "\n", "<br />")
 	// and remove double newline generated for empty lines