Hooks

All hooks are called with an options object like: hookName(options: Object). Bellow is the list of options for each hook.

Hooks by order of execution

NameDescriptionOptions
onPipelineCreatedCalled once the pipeline has been created and before its execution.config, pipeline
onSourcesFetchedCalled once all source plugins have been run.config, pipeline
onSiteCreatedCalled once Site has been instanciated and documents tree computed.config, pipeline, site
onDocumentsTransformedCalled once all documents have been transformed.config, pipeline, site
onDocumentsIndexedCalled once documents indexing has been preformed by specified search engines. If no search engines are configured, this webhook won't be called.config, pipeline, site
onOutputCalled once documents have been writen/output using all specified outputs plugins.config, pipeline, site
onDevServerListeningCalled once documents have been writen/output using all specified outputs plugins.config, pipeline, httpServer, wsServer

Usage examples

Edit this page / submit change