Skip to content

[gh config][website manual] Escape pipe symbols in long description #10688

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
iamazeem wants to merge 1 commit into from
Closed

[gh config][website manual] Escape pipe symbols in long description #10688

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions internal/docs/markdown.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,8 +142,16 @@ 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, "|", "|")
fmt.Fprintf(w, "%s\n\n", longWithEscapedPipe)
// For `gh config` command, escape pipe symbols in long description to prevent table formatting
// For more details, see https://github.com/cli/cli/issues/10348.
// This is a workaround until it's fixed in the kramdown.
// Related jekyll issue: https://github.com/jekyll/jekyll/issues/2818
if cmd.Use == "config <command>" {
longWithEscapedPipe := strings.ReplaceAll(cmd.Long, "|", "&#124;")
fmt.Fprintf(w, "%s\n\n", longWithEscapedPipe)
} else {
fmt.Fprintf(w, "%s\n\n", cmd.Long)
}
}

for _, g := range root.GroupedCommands(cmd) {
Expand Down
Loading