docgen

package
v2.65.2 Latest Latest
Warning

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func EscapeTableCell added in v2.65.2 

func EscapeTableCell(s string) string

EscapeTableCell escapes the characters that would end a Markdown table cell early. A "|" in an argument description, such as "(new | ipv4 | ipv6)", otherwise splits the cell and pushes the rest of the row into extra columns.

func GenerateDocs 

func GenerateDocs(commands *core.Commands, outDir string) error

GenerateDocs generates markdown documentation for a given list of commands

Types

type Data added in v2.57.0 

type Data struct {
	Namespaces map[string]*Namespace
}

type Namespace added in v2.57.0 

type Namespace struct {
	Cmd       *core.Command
	Commands  *core.Commands
	Resources map[string]*Resource
}

type Resource added in v2.57.0 

type Resource struct {
	Cmd   *core.Command
	Verbs map[string]*core.Command
}

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.