cmdgen

package

v0.22.0 Latest Latest Go to latest Published: Apr 6, 2020 License: MIT Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

cmdgen is a tool for generating pages from a cobra command for a Hugo site.

This section is empty.

This section is empty.

func GenerateCmdDocs(cmd *cobra.Command, dir string, opts CmdDocsGeneratorOptions) error

type CmdDocsGenerator struct {
	// contains filtered or unexported fields
}

func NewCmdDocsGenerator(dir string, opts CmdDocsGeneratorOptions) *CmdDocsGenerator

func (g *CmdDocsGenerator) GenMarkdownTree(s *hugolib.Site, cmd *cobra.Command) error

type CmdDocsGeneratorOptions struct {
	BasePath           string
	MetadataAdditional map[string]interface{}
	Menus              hugolib.PageMenus
}