Documentation
¶
Overview ¶
Package docs provides the defined docs CLI commands for Vela.
Usage:
import "github.com/go-vela/cli/command/docs"
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var CommandGenerate = &cli.Command{ Name: "docs", Description: "Use this command to generate CLI docs.", Usage: "Generate CLI documentation for repository", Action: generate, Hidden: true, Flags: []cli.Flag{ &cli.BoolFlag{ Sources: cli.EnvVars("VELA_MARKDOWN", "DOCS_MARKDOWN"), Name: "markdown", Aliases: []string{"m"}, Usage: "generate markdown docs", Value: false, }, &cli.BoolFlag{ Sources: cli.EnvVars("VELA_MAN", "DOCS_MAN"), Name: "man", Aliases: []string{"mn"}, Usage: "generate man page docs", Value: false, }, }, CustomHelpTemplate: fmt.Sprintf(`%s EXAMPLES: 1. Generate markdown docs for the CLI. $ source <({{.FullName}} --markdown true) 2. Generate man page docs for the CLI. $ source <({{.FullName}} --man true) DOCUMENTATION: https://go-vela.github.io/docs/reference/cli/docs/generate/ `, cli.CommandHelpTemplate), }
CommandGenerate defines the command for producing documentation.
Functions ¶
This section is empty.
Types ¶
This section is empty.
Click to show internal directories.
Click to hide internal directories.