cobradoc

func GenMarkdown ¶

func GenMarkdown(cmd *cobra.Command, w io.Writer) error

GenMarkdown creates markdown output.

func GenMarkdownCustom ¶

func GenMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string) string) error

GenMarkdownCustom creates custom markdown output.

func GenMarkdownTree ¶

func GenMarkdownTree(cmd *cobra.Command, dir string) error

GenMarkdownTree will generate a markdown page for this command and all descendants in the directory given. The header may be nil. This function may not work correctly if your command names have `-` in them. If you have `cmd` with two subcmds, `sub` and `sub-third`, and `sub` has a subcommand called `third`, it is undefined which help output will be in the file `cmd-sub-third.1`.

func GenMarkdownTreeCustom ¶

func GenMarkdownTreeCustom(cmd *cobra.Command, dir string, filePrepender, linkHandler func(string) string) error

GenMarkdownTreeCustom is the same as GenMarkdownTree, but with custom filePrepender and linkHandler.

func Generate ¶

func Generate(name string, cmd *cobra.Command, outputDir string, clear bool)

func IsASCIIRune ¶ added in v0.4.0

func IsASCIIRune(b byte) bool

IsASCIIRune reports whether the byte is an ASCII byte and not part of an UTF8 rune with length > 1.

func OmitTrailingSpaces ¶ added in v0.4.0

func OmitTrailingSpaces(w io.Writer) io.Writer

func OverviewOnly ¶ added in v0.4.0

func OverviewOnly(cmd *cobra.Command) bool

func SanitizePre ¶

func SanitizePre(in string) string

func UseLine ¶

func UseLine(c *cobra.Command) string

UseLine puts out the full usage for a given command (including parents).