docgen

package

v1.27.1 Latest Latest Go to latest Published: Mar 19, 2026 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

gitlab.com/gitlab-org/caproni

Links

Open Source Insights

Documentation ¶

Overview ¶

Package docgen provides utilities for generating documentation from CLI applications.

Index ¶

Variables
func GenerateMarkdown(w io.Writer, app *cli.Command) error

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ErrUnsupportedFlagType is returned when an unsupported flag type is encountered.
	ErrUnsupportedFlagType = errors.New("unsupported flag type")
)

Functions ¶

func GenerateMarkdown ¶

func GenerateMarkdown(w io.Writer, app *cli.Command) error

GenerateMarkdown generates a markdown document from a cli.Command structure. It writes the documentation to the provided writer.

Types ¶

This section is empty.

Source Files ¶

View all Source files

markdown.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL