centersl/mkdocs
1
0
Fork 0
mirror of https://github.com/mkdocs/mkdocs.git synced 2026-03-27 09:58:31 +07:00
Code Issues Packages Projects Releases Wiki Activity

Correct documentation of on_pre_template event.

Browse Source 
The behavior of this event has never changed. The documentation was simply
incorrect. Fixes #2308.
This commit is contained in:
Waylan Limberg
2021-06-02 11:59:12 -04:00
parent 80feaf03a4
commit 769a926691
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/dev-guide/plugins.md
View File

@@ -250,15 +250,15 @@ called after the [env] event and before any [page events].
##### on_pre_template
: The `pre_template` event is called immediately after the subject template is
loaded and can be used to alter the content of the template.
loaded and can be used to alter the template.
Parameters:
: __template__: the template contents as string
: __template__: a Jinja2 [Template] object
: __template_name__: string filename of template
: __config:__ global configuration object
Returns:
: template contents as string
: a Jinja2 [Template] object
##### on_template_context
@@ -487,3 +487,4 @@ tell MkDocs to use it via the config.
[on_build_error]: #on_build_error
[Handling Errors]: #handling-errors
[config_scheme]: #config_scheme
[Template]: http://code.nabla.net/doc/jinja2/api/jinja2/environment/jinja2.environment.Template.html