func GenMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string) string) error { name := cmd.CommandPath() short := cmd.Short long := cmd.Long if len(long) == 0 { long = short } if _, err := fmt.Fprintf(w, "## %s\n\n", name); err != nil { return err } if _, err := fmt.Fprintf(w, "%s\n\n", short); err != nil { return err } if _, err := fmt.Fprintf(w, "### Synopsis\n\n"); err != nil { return err } if _, err := fmt.Fprintf(w, "\n%s\n\n", long); err != nil { return err } if cmd.Runnable() { if _, err := fmt.Fprintf(w, "```\n%s\n```\n\n", cmd.UseLine()); err != nil { return err } } if len(cmd.Example) > 0 { if _, err := fmt.Fprintf(w, "### Examples\n\n"); err != nil { return err } if _, err := fmt.Fprintf(w, "```\n%s\n```\n\n", cmd.Example); err != nil { return err } } if err := printOptions(w, cmd, name); err != nil { return err } if hasSeeAlso(cmd) { if _, err := fmt.Fprintf(w, "### SEE ALSO\n"); err != nil { return err } if cmd.HasParent() { parent := cmd.Parent() pname := parent.CommandPath() link := pname + ".md" link = strings.Replace(link, " ", "_", -1) if _, err := fmt.Fprintf(w, "* [%s](%s)\t - %s\n", pname, linkHandler(link), parent.Short); err != nil { return err } cmd.VisitParents(func(c *cobra.Command) { if c.DisableAutoGenTag { cmd.DisableAutoGenTag = c.DisableAutoGenTag } }) } children := cmd.Commands() sort.Sort(byName(children)) for _, child := range children { if !child.IsAvailableCommand() || child.IsHelpCommand() { continue } cname := name + " " + child.Name() link := cname + ".md" link = strings.Replace(link, " ", "_", -1) if _, err := fmt.Fprintf(w, "* [%s](%s)\t - %s\n", cname, linkHandler(link), child.Short); err != nil { return err } } if _, err := fmt.Fprintf(w, "\n"); err != nil { return err } } if !cmd.DisableAutoGenTag { if _, err := fmt.Fprintf(w, "###### Auto generated by spf13/cobra on %s\n", time.Now().Format("2-Jan-2006")); err != nil { return err } } return nil }