generators

Documentation

Index

• func GenMarkdownTree(cmd *cobra.Command, templatesDir, outputDir string) error
• func GenMarkdownTreeCustom(cmd *cobra.Command, templatesDir, outputDir string, subdir string, ...) error
• func GenReference(cmd *cobra.Command, templatesDir string, w io.Writer, ...) error
• type Link
• type Option
• type Reference

Functions

func GenMarkdownTree

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

func GenMarkdownTreeCustom

func GenMarkdownTreeCustom(cmd *cobra.Command, templatesDir, outputDir string, subdir string, filePrepender, linkHandler func(string) string) error

func GenReference

func GenReference(cmd *cobra.Command, templatesDir string, w io.Writer, linkHandler func(string) string, indexFile bool) error

Types

type Link

type Link struct {
	Name        string
	Description string
	Path        string
}

type Option

type Option struct {
	Name        string
	Shorthand   string
	Usage       string
	ValueType   string
	DefVal      string
	NoOptDefVal string
}

type Reference

type Reference struct {
	NoList           bool
	Title            string
	Description      string
	ShowUseLine      bool
	UseLine          string
	ShowExample      bool
	Example          string
	Options          []Option
	InheritedOptions []Option
	Links            []Link
}