dan
/
jekyll
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Adds some documentation for the :clean, :on_obsolete hook (#7954) 

Merge pull request 7954
This commit is contained in:
Phil Nash 2019-12-30 19:36:16 +11:00 committed by jekyllbot
parent af0f6aad34
commit af65fa45e3
1 changed files with 18 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
docs/_docs/plugins/hooks.md
View File

@ -20,13 +20,13 @@ end
```
Jekyll provides hooks for <code>:site</code>, <code>:pages</code>,
<code>:posts</code>, and <code>:documents</code>. 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).
<code>:posts</code>, <code>:documents</code> and <code>:clean</code>. 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:
<p>After writing a document to disk</p>
</td>
</tr>
<tr>
<td>
<p><code>:clean</code></p>
</td>
<td>
<p><code>:on_obsolete</code></p>
</td>
<td>
<p>During the cleanup of a site's destination before it is built</p>
</td>
</tr>
</tbody>
</table>
</div>