Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

generators

package

Go to main page

Versions in this module

v0

v0.5.0

Jul 29, 2020

v0.4.2

Apr 8, 2020

v0.4.1

Apr 8, 2020

v0.4.0

Mar 24, 2020

v0.3.0

Jan 16, 2020

v0.2.0

Nov 26, 2019

v0.1.0

Oct 28, 2019

Changes in this version

+ const JSONOutputFile

+ var CategoryTemplate = ...

+ var CommandTemplate = ...

+ var GenPulsarctlDir = flag.String("gen-pulsarctl-dir", "site/gen-pulsarctldocs/generators", ...)

+ var PulsarVersion = flag.String("pulsar-version", "", "Version of Pulsar to generate docs for.")

+ func FormatCommand(c *Command)

+ func FormatDescription(input string) string

+ func FormatExample(input string) string

+ func GenerateFiles()

+ func NormalizeSpec(spec *PulsarctlSpec)

+ func WriteCategoryFile(c Category)

+ func WriteCommandFile(manifest *Manifest, t *template.Template, params TopLevelCommand)

+ func WriteCommandFiles(manifest *Manifest, toc ToC, params PulsarctlSpec)

+ func WriteManifest(manifest *Manifest)

+ type Category struct

+ Commands []string

+ Include string

+ Name string

+ type Command struct

+ Description string

+ Example string

+ InheritedOptions Options

+ Name string

+ Options Options

+ Path string

+ SeeAlso []string

+ Synopsis string

+ Usage string

+ func NewCommand(c *cobra.Command, path string) *Command

+ type Commands []*Command

+ func NewSubCommands(c *cobra.Command, path string) Commands

+ func (a Commands) Len() int

+ func (a Commands) Less(i, j int) bool

+ func (a Commands) Swap(i, j int)

+ type Doc struct

+ Filename string

+ type Manifest struct

+ Copyright string

+ Docs []Doc

+ Title string

+ type Option struct

+ DefaultValue string

+ Name string

+ Shorthand string

+ Usage string

+ type Options []*Option

+ func NewOptions(flags *pflag.FlagSet) Options

+ func (a Options) Len() int

+ func (a Options) Less(i, j int) bool

+ func (a Options) Swap(i, j int)

+ type PulsarctlSpec struct

+ TopLevelCommandGroups []TopLevelCommands

+ func GetSpec() PulsarctlSpec

+ func NewPulsarctlSpec(c *cobra.Command) PulsarctlSpec

+ type ToC struct

+ Categories []Category

+ type TopLevelCommand struct

+ MainCommand *Command

+ SubCommands Commands

+ func NewTopLevelCommand(c *cobra.Command) TopLevelCommand

+ type TopLevelCommands struct

+ Commands []TopLevelCommand

+ func NewTopLevelCommands(cs []*cobra.Command) TopLevelCommands

+ func (a TopLevelCommands) Len() int

+ func (a TopLevelCommands) Less(i, j int) bool

+ func (a TopLevelCommands) Swap(i, j int)