2.3 KiB
Working with templates and UI
The pages of the JupyterHub application are generated from Jinja templates. These allow the header, for example, to be defined once and incorporated into all pages. By providing your own templates, you can have complete control over JupyterHub's appearance.
Custom Templates
JupyterHub will look for custom templates in all of the paths in the
JupyterHub.template_paths configuration option, falling back on the
default templates
if no custom template with that name is found. This fallback
behavior is new in version 0.9; previous versions searched only those paths
explicitly included in template_paths. You may override as many
or as few templates as you desire.
Extending Templates
Jinja provides a mechanism to extend templates.
A base template can define a block, and child templates can replace or
supplement the material in the block. The
JupyterHub templates
make extensive use of blocks, which allows you to customize parts of the
interface easily.
In general, a child template can extend a base template, base.html, by beginning with:
{% extends "base.html" %}
This works, unless you are trying to extend the default template for the same
file name. Starting in version 0.9, you may refer to the base file with a
templates/ prefix. Thus, if you are writing a custom base.html, start the
file with this block:
{% extends "templates/base.html" %}
By defining blocks with same name as in the base template, child templates
can replace those sections with custom content. The content from the base
template can be included with the {{ super() }} directive.
Example
To add an additional message to the spawn-pending page, below the existing
text about the server starting up, place this content in a file named
spawn_pending.html in a directory included in the
JupyterHub.template_paths configuration option.
{% extends "templates/spawn_pending.html" %}
{% block message %}
{{ super() }}
<p>Patience is a virtue.</p>
{% endblock %}