From 206896c6b4fa63ed10977c73b78bde0e3ad9ae77 Mon Sep 17 00:00:00 2001 From: meiji163 Date: Wed, 17 Nov 2021 13:33:34 -0800 Subject: [PATCH] fix angle brackets --- internal/docs/man.go | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/internal/docs/man.go b/internal/docs/man.go index 570e9c780..ec2e458f5 100644 --- a/internal/docs/man.go +++ b/internal/docs/man.go @@ -96,6 +96,7 @@ func GenMan(cmd *cobra.Command, header *GenManHeader, w io.Writer) error { } b := genMan(cmd, header) + _, err := w.Write(md2man.Render(b)) return err } @@ -133,7 +134,13 @@ func manPreamble(buf *bytes.Buffer, header *GenManHeader, cmd *cobra.Command, da `, header.Title, header.Section, header.date, header.Source, header.Manual)) buf.WriteString(fmt.Sprintf("%s \\- %s\n\n", dashedName, cmd.Short)) buf.WriteString("# SYNOPSIS\n") - buf.WriteString(fmt.Sprintf("**%s**\n\n", cmd.UseLine())) + + // "<>" is rendered as HTML in md + synopsis := cmd.UseLine() + escAngle := strings.Replace(synopsis, "<", "\\<", -1) + escAngle = strings.Replace(escAngle, ">", "\\>", -1) + buf.WriteString(fmt.Sprintf("**%s**\n\n", escAngle)) + buf.WriteString("# DESCRIPTION\n") buf.WriteString(description + "\n\n") }