diff --git a/internal/docs/markdown.go b/internal/docs/markdown.go index 7ae8c6862..05d8686b8 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) { 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 {