plugin

Documentation

Index

• func LoadAll(cfg *config.Config, fs afero.Fs, outputDir string) map[string]func() Plugin
• type Plugin
• type PrePostProcessPlugin

Functions

func LoadAll

func LoadAll(cfg *config.Config, fs afero.Fs, outputDir string) map[string]func() Plugin

LoadAll returns a map of all available plugins. Each entry is a function that returns a fully initialized plugin instance.

Types

type Plugin

type Plugin interface {
	// ProcessPage will be invoked after parsing the page. Must be safe
	// for concurrent usage.
	ProcessPage(page *model.Page) error
	// PreWrite will be invoked before writing the site.
	PreWrite(site *model.Site) error
	// PostWrite will be invoked after writing the site.
	PostWrite() error
}

Plugin represents a built-in verless plugin.

type PrePostProcessPlugin

type PrePostProcessPlugin interface {
	Plugin

	// PreProcessPages will be invoked before all pages get processed.
	// So this will be called only once.
	PreProcessPages() error
	// PostProcessPages will be invoked after all pages were processed.
	// So this will be called only once.
	PostProcessPages() error
}