cobradoc

package
v0.8.3 Latest Latest
Warning

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

Go to latest
Published: Apr 23, 2025 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package cobradoc is used to generate documentation from cobra commands.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func List

func List(cmd *cobra.Command, hidden bool, out io.Writer)

List outputs a list of cobra commands.

func Markdown

func Markdown(cmd *cobra.Command, out io.Writer) error

Markdown outputs docs on a cobra command in Markdown format.

func NewCmd

func NewCmd(rootName, newName string) *cobra.Command

NewCmd generates a new cobra command for generating docs.

Types

This section is empty.

Jump to

Keyboard shortcuts

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