plugin

Jul 23, 2026

Changes in this version

+ type ProbeResult struct

+ Description string

+ Hooks []Phase

+ HooksErr error

+ InfoErr error

+ Path string

+ SpeaksProtocol bool

+ Version string

+ func Probe(execPath string) (ProbeResult, error)

Mar 19, 2026

Changes in this version

+ type ExternalPlugin struct

+ func NewExternalPlugin(name, execPath string, pluginCfg map[string]interface{}) (*ExternalPlugin, error)

+ func (p *ExternalPlugin) Cleanup() error

+ func (p *ExternalPlugin) Description() string

+ func (p *ExternalPlugin) Execute(hookCtx *HookContext) (*HookResult, error)

+ func (p *ExternalPlugin) Hooks() []Phase

+ func (p *ExternalPlugin) Init(_ *config.BookConfig) error

+ func (p *ExternalPlugin) Name() string

+ func (p *ExternalPlugin) Version() string

+ type ExternalPluginRequest struct

+ ChapterFile string

+ ChapterIndex int

+ Config map[string]interface{}

+ Content string

+ Metadata map[string]interface{}

+ OutputFormat string

+ OutputPath string

+ Phase string

+ type ExternalPluginResponse struct

+ Content string

+ Error string

+ Stop bool

type Manager

+ func LoadPlugins(cfg *config.BookConfig) (*Manager, error)

+ func MustLoadPlugins(cfg *config.BookConfig, warnFn func(msg string)) *Manager

type Phase

+ const PhaseAfterBuild

+ const PhaseAfterServe

+ const PhaseBeforeBuild

+ const PhaseBeforeServe

Mar 19, 2026

Changes in this version

+ type HookContext struct

+ ChapterFile string

+ ChapterIndex int

+ Config *config.BookConfig

+ Content string

+ Context context.Context

+ Metadata map[string]interface{}

+ OutputFormat string

+ OutputPath string

+ Phase Phase

+ type HookResult struct

+ Content string

+ Stop bool

+ type Manager struct

+ func NewManager() *Manager

+ func (m *Manager) CleanupAll() error

+ func (m *Manager) InitAll(cfg *config.BookConfig) error

+ func (m *Manager) Plugins() []Plugin

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

+ func (m *Manager) RunHook(hookCtx *HookContext) error

+ type Phase string

+ const PhaseAfterOutput

+ const PhaseAfterParse

+ const PhaseAfterRender

+ const PhaseBeforeOutput

+ const PhaseBeforeParse

+ const PhaseBeforeRender

+ const PhaseConfigLoaded

+ type Plugin interface

+ Cleanup func() error

+ Description func() string

+ Execute func(hookCtx *HookContext) (*HookResult, error)

+ Hooks func() []Phase

+ Init func(cfg *config.BookConfig) error

+ Name func() string

+ Version func() string

+ type PluginError struct

+ Err error

+ Phase string

+ PluginName string

+ func (e *PluginError) Error() string

+ func (e *PluginError) Unwrap() error