From 800a645e0e69ad026f03abacb7e724bb5a6b0857 Mon Sep 17 00:00:00 2001 From: Azeem Sajid Date: Tue, 4 Feb 2025 18:16:13 +0500 Subject: [PATCH 1/2] [gh config] Escape pipe symbol in Long desc for website manual --- internal/docs/markdown.go | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/internal/docs/markdown.go b/internal/docs/markdown.go index 7ae8c6862..b7018c640 100644 --- a/internal/docs/markdown.go +++ b/internal/docs/markdown.go @@ -142,7 +142,8 @@ func genMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string) fmt.Fprintf(w, "```\n%s\n```\n\n", cmd.UseLine()) } if hasLong { - fmt.Fprintf(w, "%s\n\n", cmd.Long) + longWithEscapedPipe := strings.ReplaceAll(cmd.Long, "|", "\\|") + fmt.Fprintf(w, "%s\n\n", longWithEscapedPipe) } for _, g := range root.GroupedCommands(cmd) { From a4b86bff777791b0c07bddbde80beb5994a7f88d Mon Sep 17 00:00:00 2001 From: Azeem Sajid Date: Tue, 4 Feb 2025 18:48:56 +0500 Subject: [PATCH 2/2] Use HTML numeric code instead of escaping with slash --- internal/docs/markdown.go | 2 +- pkg/cmd/config/config.go | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/internal/docs/markdown.go b/internal/docs/markdown.go index b7018c640..05d8686b8 100644 --- a/internal/docs/markdown.go +++ b/internal/docs/markdown.go @@ -142,7 +142,7 @@ func genMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string) fmt.Fprintf(w, "```\n%s\n```\n\n", cmd.UseLine()) } if hasLong { - longWithEscapedPipe := strings.ReplaceAll(cmd.Long, "|", "\\|") + longWithEscapedPipe := strings.ReplaceAll(cmd.Long, "|", "|") fmt.Fprintf(w, "%s\n\n", longWithEscapedPipe) } diff --git a/pkg/cmd/config/config.go b/pkg/cmd/config/config.go index 2661c3369..66051f83a 100644 --- a/pkg/cmd/config/config.go +++ b/pkg/cmd/config/config.go @@ -16,7 +16,7 @@ import ( func NewCmdConfig(f *cmdutil.Factory) *cobra.Command { longDoc := strings.Builder{} longDoc.WriteString("Display or change configuration settings for gh.\n\n") - longDoc.WriteString("Current respected settings:\n") + longDoc.WriteString("Current respected settings:\n\n") for _, co := range config.Options { longDoc.WriteString(fmt.Sprintf("- `%s`: %s", co.Key, co.Description)) if len(co.AllowedValues) > 0 {