Documentation
¶
Overview ¶
Package plugin defines the gohan plugin interface and built-in plugin registry.
Plugins are compiled into the gohan binary and enabled/disabled via config.yaml:
plugins:
amazon_books:
enabled: true
tag: "your-associate-tag-22"
Each plugin receives a ProcessedArticle and its own config section, and returns arbitrary data that the theme template can access via .PluginData.<plugin_name>.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Plugin ¶
type Plugin interface {
// Name returns the unique identifier of the plugin.
// This key is used in config.yaml under plugins.<name>
// and as the key in ProcessedArticle.PluginData.
Name() string
// Enabled reports whether the plugin is active for the given config section.
// cfg is the map under plugins.<name> in config.yaml.
Enabled(cfg map[string]interface{}) bool
// TemplateData returns data to inject into the template context for the
// given article. The returned map is stored at .PluginData.<name> in
// the template.
TemplateData(article *model.ProcessedArticle, cfg map[string]interface{}) (map[string]interface{}, error)
}
Plugin is the interface that all gohan plugins must implement.
type Registry ¶
type Registry struct {
// contains filtered or unexported fields
}
Registry holds the set of built-in plugins.
func DefaultRegistry ¶
func DefaultRegistry() *Registry
DefaultRegistry returns a Registry pre-loaded with all built-in plugins.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package amazonbooks is a gohan built-in plugin that generates Amazon book cards for article templates.
|
Package amazonbooks is a gohan built-in plugin that generates Amazon book cards for article templates. |
Click to show internal directories.
Click to hide internal directories.