func GenerateSingle(cmd *cobra.Command, out *bytes.Buffer, linkHandler func(string) string, specs []string) { name := cmd.CommandPath() short := cmd.Short long := cmd.Long if len(long) == 0 { long = short } fmt.Fprintf(out, "# %s\n\n", name) fmt.Fprintf(out, "%s\n\n", short) fmt.Fprintf(out, "## Synopsis\n") fmt.Fprintf(out, "\n%s\n\n", long) if cmd.Runnable() { fmt.Fprintf(out, "```bash\n%s\n```\n\n", cmd.UseLine()) } if len(cmd.Example) > 0 { fmt.Fprintf(out, "## Examples\n\n") fmt.Fprintf(out, "```bash\n%s\n```\n\n", cmd.Example) } flags := cmd.NonInheritedFlags() flags.SetOutput(out) if flags.HasFlags() { fmt.Fprintf(out, "## Options\n\n```\n") flags.PrintDefaults() fmt.Fprintf(out, "```\n\n") } parentFlags := cmd.InheritedFlags() parentFlags.SetOutput(out) if parentFlags.HasFlags() { fmt.Fprintf(out, "## Options inherited from parent commands\n\n```\n") parentFlags.PrintDefaults() fmt.Fprintf(out, "```\n\n") } if len(cmd.Commands()) > 0 { fmt.Fprintf(out, "## Subcommands\n\n") children := cmd.Commands() sort.Sort(byName(children)) for _, child := range children { if len(child.Deprecated) > 0 { continue } cname := name + " " + child.Name() link := cname + ".md" link = strings.Replace(link, " ", "_", -1) fmt.Fprintf(out, "* [%s](%s)\t - %s\n", cname, linkHandler(link), child.Short) } } if len(cmd.Commands()) > 0 && cmd.HasParent() { fmt.Fprintf(out, "\n") } if cmd.HasParent() { fmt.Fprintf(out, "## See Also\n\n") parent := cmd.Parent() pname := parent.CommandPath() link := pname + ".md" link = strings.Replace(link, " ", "_", -1) fmt.Fprintf(out, "* [%s](%s)\t - %s\n", pname, linkHandler(link), parent.Short) } fmt.Fprintf(out, "\n## Specifications\n\n") for _, spec := range specs { spec = strings.Replace(spec, RENDER_DIR, "", 1) title := strings.Replace(spec, "_", " ", -1) title = strings.Replace(title, ".md", "", 1) // title = strings.Replace(title, "spec", "specification", 1) title = strings.Title(title) fmt.Fprintf(out, "* [%s](%s)\n", title, linkHandler(spec)) } fmt.Fprintf(out, "\n") }
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 }