From af65fa45e30ab81e53e0599bf202a5591cba289a Mon Sep 17 00:00:00 2001 From: Phil Nash Date: Mon, 30 Dec 2019 19:36:16 +1100 Subject: [PATCH] Adds some documentation for the :clean, :on_obsolete hook (#7954) Merge pull request 7954 --- docs/_docs/plugins/hooks.md | 25 ++++++++++++++++++------- 1 file changed, 18 insertions(+), 7 deletions(-) diff --git a/docs/_docs/plugins/hooks.md b/docs/_docs/plugins/hooks.md index e09f166a..721a8c97 100644 --- a/docs/_docs/plugins/hooks.md +++ b/docs/_docs/plugins/hooks.md @@ -20,13 +20,13 @@ end ``` Jekyll provides hooks for :site, :pages, -:posts, and :documents. In all cases, Jekyll calls -your hooks with the container object as the first callback parameter. -All `:pre_render` hooks and the`:site, :post_render` hook will also provide a -payload hash as a second parameter. In the case of `:pre_render`, the payload -gives you full control over the variables that are available while rendering. -In the case of `:site, :post_render`, the payload contains final values after -rendering all the site (useful for sitemaps, feeds, etc). +:posts, :documents and :clean. In all +cases, Jekyll calls your hooks with the container object as the first callback +parameter. All `:pre_render` hooks and the`:site, :post_render` hook will also +provide a payload hash as a second parameter. In the case of `:pre_render`, the +payload gives you full control over the variables that are available while +rendering. In the case of `:site, :post_render`, the payload contains final +values after rendering all the site (useful for sitemaps, feeds, etc). The complete list of available hooks is below: @@ -239,6 +239,17 @@ The complete list of available hooks is below:

After writing a document to disk

+ + +

:clean

+ + +

:on_obsolete

+ + +

During the cleanup of a site's destination before it is built

+ +