markdown

package

v0.2.2 Latest Latest Go to latest Published: Apr 10, 2026 License: MIT Imports: 11 Imported by: 0

Details

Package markdown provides an output plugin for exporting themes to markdown format.

This section is empty.

This section is empty.

This section is empty.

type Plugin struct {
	// contains filtered or unexported fields
}

Plugin implements the output.Plugin interface for markdown theme export.

func New() *Plugin

New creates a new markdown output plugin with default settings.

func (p *Plugin) DefaultOutputDir() string

DefaultOutputDir returns the default output directory for this plugin.

func (p *Plugin) Description() string

Description returns the plugin description.

func (p *Plugin) Generate(themeData *colour.ThemeData) (map[string][]byte, error)

Generate creates a markdown theme file from the given theme data.

func (p *Plugin) GetFlagHelp() []output.FlagHelp

GetFlagHelp returns help information for all plugin flags.

func (p *Plugin) Name() string

Name returns the plugin name.

func (p *Plugin) RegisterFlags(cmd *cobra.Command)

RegisterFlags registers plugin-specific flags with the cobra command.

func (p *Plugin) SetVerbose(verbose bool)

SetVerbose enables or disables verbose logging for the plugin.

func (p *Plugin) Validate() error

Validate checks if the plugin configuration is valid.

func (p *Plugin) Version() string

Version returns the plugin version.