Help us shape the future of Go! Take the 2026 Go Developer Survey

docs

package
v0.28.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 22, 2026 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Package docs provides the defined CLI docs actions for Vela.

Usage: 

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

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Config 

type Config struct {
	Action   string
	Markdown bool
	Man      bool
}

Config represents the configuration necessary to perform docs related requests with Vela.

func (*Config) Generate 

func (c *Config) Generate(cmd *cli.Command) error

Generate produces documentation for the CLI.

func (*Config) Validate 

func (c *Config) Validate() error

Validate verifies the configuration provided.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.