docs

Documentation

Overview

Package docs provides the defined docs CLI commands for Vela.

Usage:

import "github.com/go-vela/cli/command/docs"

Index

• Variables

Variables

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.StringFlag{
			EnvVars: []string{"VELA_MARKDOWN", "DOCS_MARKDOWN"},
			Name:    "markdown",
			Aliases: []string{"m"},
			Usage:   "generate markdown docs",
			Value:   "false",
		},
		&cli.StringFlag{
			EnvVars: []string{"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 <({{.HelpName}} --markdown true)
  2. Generate man page docs for the CLI.
    $ source <({{.HelpName}} --man true)

DOCUMENTATION:

  https://go-vela.github.io/docs/reference/cli/docs/generate/
`, cli.CommandHelpTemplate),
}

CommandGenerate defines the command for producing documentation.