glenux-archive/spf13--cobra
1
0
Fork 0
mirror of https://github.com/spf13/cobra synced 2025-06-17 09:47:19 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #1 from commit111/print-aliases

Browse source 
Print command aliases in docs
This commit is contained in:
Linda L. 2025-04-25 11:41:38 -07:00 • committed by GitHub
commit 249c202df3
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
doc/md_docs.go
View file

@ -72,6 +72,17 @@ func GenMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string)
buf.WriteString(fmt.Sprintf("```\n%s\n```\n\n", cmd.UseLine()))
}
if len(cmd.Aliases) > 0 {
buf.WriteString("Aliases: ")
for _, alias := range cmd.Aliases {
buf.WriteString(fmt.Sprintf("`%s`", alias))
if alias != cmd.Aliases[len(cmd.Aliases)-1] {
buf.WriteString(", ")
}
}
buf.WriteString("\n")
}
if len(cmd.Example) > 0 {
buf.WriteString("### Examples\n\n")
buf.WriteString(fmt.Sprintf("```\n%s\n```\n\n", cmd.Example))