Using {{ super() }} for extending a block (#4309)

* Using `{{ super() }}` for extending a block

Yesterday we were struggling with adding a Zendesk widget (a simple JS) to our docs, because overriding any existing template block would lead to a broken site. Finally, we found this function which saved us. I wanted to share this, because it's not a common knowledge and it might be helpful for others.

* suggested correction
This commit is contained in:
Darek 2022-09-11 16:44:06 +02:00 committed by GitHub
parent 1a9bc1dd6a
commit 54d0a992b7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -170,6 +170,19 @@ Then, e.g. to override the site title, add the following lines to `main.html`:
{% endblock %} {% endblock %}
``` ```
If you intend to add some code to a block rather than to replace it altogether with new content, use `{{ super() }}` right after the `{% block %}` statement to include the original block content. This is particularly useful when adding some third-party widgets to your docs, e.g., for chatting with support or submitting a ticket. For example, if your widget script is hosted on `widgets.example.com`, add the following lines to `main.html`:
```html
{% extends "base.html" %}
{% block scripts %}
{{ super() }}
<script id="snippet" src="https://widgets.example.com/snippet.js> </script>
{% endblock %}
The following template blocks are provided by the theme: The following template blocks are provided by the theme:
| Block name | Purpose | | Block name | Purpose |