diff --git a/doc/md_docs.go b/doc/md_docs.go index 6eae7ccfb..a1fd2eeca 100644 --- a/doc/md_docs.go +++ b/doc/md_docs.go @@ -63,15 +63,19 @@ func GenMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string) buf.WriteString("## " + name + "\n\n") buf.WriteString(cmd.Short + "\n\n") - if len(cmd.Long) > 0 { - buf.WriteString("### Synopsis\n\n") - buf.WriteString(cmd.Long + "\n\n") - } if cmd.Runnable() { + if len(cmd.Long) > 0 { + buf.WriteString("### Synopsis\n\n") + } fmt.Fprintf(buf, "```\n%s\n```\n\n", cmd.UseLine()) } + if len(cmd.Long) > 0 { + buf.WriteString("### Description\n\n") + buf.WriteString(cmd.Long + "\n\n") + } + if len(cmd.Example) > 0 { buf.WriteString("### Examples\n\n") fmt.Fprintf(buf, "```\n%s\n```\n\n", cmd.Example)