cmddocs

package

v0.4.1 Latest Latest Go to latest Published: Dec 3, 2025 License: MIT Imports: 4 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 ¶

Overview ¶

Package cmddocs provides functionality for parsing and executing templates used for CLI command documentation. It allows command descriptions to be maintained in external Markdown files or embedded strings, supporting dynamic content generation.

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

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