cmdgen

Documentation

Overview

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

Index

• func GenerateCmdDocs(cmd *cobra.Command, dir string, opts CmdDocsGeneratorOptions) error
• type CmdDocsGenerator
  • func NewCmdDocsGenerator(dir string, opts CmdDocsGeneratorOptions) *CmdDocsGenerator
  • func (g *CmdDocsGenerator) GenMarkdownTree(s *hugolib.Site, cmd *cobra.Command) error
• type CmdDocsGeneratorOptions

Functions

func GenerateCmdDocs

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

Types

type CmdDocsGenerator

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

func NewCmdDocsGenerator

func NewCmdDocsGenerator(dir string, opts CmdDocsGeneratorOptions) *CmdDocsGenerator

func (*CmdDocsGenerator) GenMarkdownTree

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

type CmdDocsGeneratorOptions

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