customdocs

package

v0.7.3 Latest Latest Go to latest Published: Jul 31, 2023 License: Apache-2.0 Imports: 7 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

This section is empty.

This section is empty.

func GenTreeWithTemplate(cmd *cobra.Command, dir string, template Template) error

GenTreeWithTemplate outputs CLI docs for the command and all sub-commands into a directory, using the provided template.

func GenWithTemplate(cmd *cobra.Command, w io.Writer, template Template) error

GenWithTemplate outputs CLI docs based on the provided template (text/template or html/template).

type Template interface {
	Execute(wr io.Writer, data interface{}) error
}

Template interface is implemented by core packages text/template and html/template.