Documentation
¶
Overview ¶
Package markdown provides an input plugin for loading themes from markdown theme files.
Index ¶
- type Plugin
- func (p *Plugin) Description() string
- func (p *Plugin) Generate(_ context.Context, opts input.GenerateOptions) (*colour.Palette, error)
- func (p *Plugin) GetFlagHelp() []input.FlagHelp
- func (p *Plugin) Name() string
- func (p *Plugin) RegisterFlags(cmd *cobra.Command)
- func (p *Plugin) Validate() error
- func (p *Plugin) Version() string
- func (p *Plugin) WallpaperPath() string
- func (p *Plugin) WallpaperRawPath() string
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Plugin ¶
type Plugin struct {
// contains filtered or unexported fields
}
Plugin implements the input.Plugin interface for markdown theme loading.
func (*Plugin) Description ¶
Description returns the plugin description.
func (*Plugin) GetFlagHelp ¶
GetFlagHelp returns help information for all plugin flags.
func (*Plugin) RegisterFlags ¶
RegisterFlags registers plugin-specific flags with the cobra command.
func (*Plugin) WallpaperPath ¶
WallpaperPath returns the canonical path to the wallpaper (extracted or referenced). For external references, this is the resolved absolute path. For embedded wallpapers, this is the path to the extracted file. Implements the input.WallpaperProvider interface.
func (*Plugin) WallpaperRawPath ¶ added in v0.1.22
WallpaperRawPath returns the original path from the theme file. For external references, this is the path as written in the theme file. For embedded wallpapers, this is the same as WallpaperPath (extracted file path). Implements the input.WallpaperProvider interface.
Source Files