docs

package

v2.0.1 Latest Latest Go to latest Published: Nov 7, 2025 License: BSD-2-Clause Imports: 9 Imported by: 0

Details

This section is empty.

This section is empty.

func Generate(schema schema.Schema, format DocFormat, out io.Writer) error

type CommandData struct {
	schema.Command
	Program string
	Path    []string
}

func (d CommandData) DocText() string

func (d CommandData) DocTextHTML() string

func (d CommandData) DocTextMarkdown() string

type Data struct {
	Program     ProgramData
	CommandList []CommandData
}

func ConstructData(s schema.Schema) Data

type DocFormat string

const (
	DocFormatHTML     DocFormat = "html"
	DocFormatMarkdown DocFormat = "markdown"
	DocFormatText     DocFormat = "text"
)

type ProgramData struct {
	Name    string
	Version string
}