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

[Vegebutcher]

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.

[squidfunk]

Thanks for the PR! Shouldn't it be after the block statement, so that it's in the block?

[Vegebutcher]

Thanks for the PR! Shouldn't it be after the block statement, so that it's in the block?

I'm not sure. It works for us when it's before block. But it can be at the end as well. Both ways are presented here.

[squidfunk]

I'm not sure we're talking about the same thing. Please provide an example for clarification.

[Vegebutcher]

OK, so this is how we implemented the Zendesk widget:

{% extends "base.html" %}

{% block scripts %}

{{ super() }}
<!-- Start of xorlab Zendesk Widget script -->
<script id="ze-snippet" src="https://static.zdassets.com/ekr/snippet.js?key=xxxxxxxxxxx"> </script>
<!-- End of xorlab Zendesk Widget script -->

{% endblock %}

Now I got your point: I meant the new content in a block, but wrote about a block statement. My bad. Yes, this super function should be invoked inside the block, but I am not sure if it really matters if it's before or after the new content.

[squidfunk]

Thanks! Yes, it matters. The content of the block is expanded where the super call is located, so order definitely matters.

[Vegebutcher]

correction to instructions

[squidfunk]

Thanks! LGTM. I might adjust the formatting a little.