plugin

package

Go to main page

Versions in this module

v1

v1.4.0

Aug 29, 2026

v1.3.0

Aug 6, 2026

v1.2.0

Aug 4, 2026

Changes in this version

+ const RenderedFallbackMaxChars

+ func ExtractSearchText(s string) string

+ func RenderedTextFallback(content template.HTML, maxChars int) string

+ func ShouldExcludePath(urlPath string, patterns []string) bool

+ func StripHTML(s string) string

+ func TrimTitlePrefix(text, title string) string

+ func TruncateRuneSafe(s string, max int) string

type BuildDoneContext

+ ProjectDir string

v1.1.0

Jul 29, 2026

v1.0.1

Jul 25, 2026

v1.0.0

Jul 24, 2026

Changes in this version

+ func MatchesInjectRule(rule string, page *engine.Page, rd *engine.RouteData) bool

+ func WriteFSTree(ctx *BuildDoneContext, fsys fs.FS, root, destPrefix string) error

+ func WriteFSTreeFiltered(ctx *BuildDoneContext, fsys fs.FS, root, destPrefix string, ...) error

type BeforeRenderContext

+ func (c *BeforeRenderContext) BaseURL() string

type BuildDoneContext

+ ChangedPages []*engine.Page

+ Incremental bool

+ RemovedPermalinks []string

+ func (c *BuildDoneContext) BaseURL() string

v0

v0.1.1

Jun 27, 2026

Changes in this version

+ const LangAwareAnnouncementFunc

+ func BuiltinNames() []string

+ func LintPages(pages []*engine.Page, lint config.ContentLintSettings) []engine.ValidationWarning

+ type BeforeRenderContext struct

+ Page *engine.Page

+ PluginConfig map[string]any

+ Resolver *engine.URLResolver

+ RouteData *engine.RouteData

+ Site *engine.SiteContext

+ func (c *BeforeRenderContext) AbsURL(relPath, lang, version string) string

+ func (c *BeforeRenderContext) Get(key string) any

+ func (c *BeforeRenderContext) ResolveURL(relPath, lang, version string) string

+ func (c *BeforeRenderContext) Set(key string, value any)

+ type BuildDoneContext struct

+ Collections map[string]*engine.Collection

+ Config *config.SiteConfig

+ DevMode bool

+ OutputDir string

+ PageIndex *content.PageIndex

+ Pages []*engine.Page

+ PluginConfig map[string]any

+ Resolver *engine.URLResolver

+ Site *engine.SiteContext

+ TrackFn func(string)

+ ValidationData map[string]engine.ValidationEntry

+ func (c *BuildDoneContext) AbsURL(relPath, lang, version string) string

+ func (c *BuildDoneContext) AddWarning(w engine.ValidationWarning)

+ func (c *BuildDoneContext) Log(message string)

+ func (c *BuildDoneContext) ResolveURL(relPath, lang, version string) string

+ func (c *BuildDoneContext) SetLogger(l *engine.BuildLogger)

+ func (c *BuildDoneContext) SetWarnings(w *[]engine.ValidationWarning)

+ func (c *BuildDoneContext) WriteFile(relPath string, data []byte) error

+ type ConfigSetupContext struct

+ Config *config.SiteConfig

+ PluginConfig map[string]any

+ TemplateFuncs map[string]any

+ func (c *ConfigSetupContext) AddTemplateFunc(name string, fn any)

+ func (c *ConfigSetupContext) Get(key string) any

+ func (c *ConfigSetupContext) Set(key string, value any)

+ type ContentLoadedContext struct

+ Collections map[string]*engine.Collection

+ Config *config.SiteConfig

+ Pages *[]*engine.Page

+ PluginConfig map[string]any

+ func (c *ContentLoadedContext) Get(key string) any

+ func (c *ContentLoadedContext) InjectPage(page *engine.Page)

+ func (c *ContentLoadedContext) Set(key string, value any)

+ type Manager struct

+ func NewManager() *Manager

+ func (m *Manager) Register(p *Plugin)

+ func (m *Manager) RegisterBuiltins(enabled []string, configs map[string]map[string]any)

+ func (m *Manager) RunBeforeRender(cfg *config.SiteConfig, page *engine.Page, rd *engine.RouteData, ...) error

+ func (m *Manager) RunBuildDone(ctx *BuildDoneContext) error

+ func (m *Manager) RunConfigSetup(cfg *config.SiteConfig) error

+ func (m *Manager) RunContentLoaded(cfg *config.SiteConfig, collections map[string]*engine.Collection, ...) error

+ func (m *Manager) TemplateFuncs() map[string]any

+ func (m *Manager) Warnings() []engine.ValidationWarning

+ type Plugin struct

+ Hooks PluginHooks

+ Name string

+ type PluginHooks struct

+ BeforeRender func(ctx *BeforeRenderContext) error

+ BuildDone func(ctx *BuildDoneContext) error

+ ConfigSetup func(ctx *ConfigSetupContext) error

+ ContentLoaded func(ctx *ContentLoadedContext) error

+ type SharedStore struct

+ func NewStore() *SharedStore

+ func (s *SharedStore) Get(key string) any

+ func (s *SharedStore) Set(key string, value any)

v0.1.0

Jun 27, 2026

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