cmddocs

package

v0.4.0 Latest Latest Go to latest Published: Dec 1, 2025 License: MIT Imports: 3 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/contextvibes/cli

Links

Open Source Insights

Documentation ¶

Index ¶

type CommandDesc
- func ParseAndExecute(templateContent string, data any) (CommandDesc, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type CommandDesc ¶

type CommandDesc struct {
	Short string
	Long  string
}

CommandDesc contains the short and long descriptions for a cobra command.

func ParseAndExecute ¶

func ParseAndExecute(templateContent string, data any) (CommandDesc, error)

ParseAndExecute parses a Markdown template, executes it with the provided data, and extracts the Short and Long descriptions. It expects the first non-empty line after templating to be an H1 title (e.g., "# Command Short Desc").

Source Files ¶

View all Source files

parser.go

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