Templates¶

Dactyl provides built-in templates that are fairly full-featured, but you can also write your own, including ones that extent or repurpose parts of the built-in templates, and get updates automatically when Dactyl is updated. As an example, this page uses a custom template that addsa "related pages" module to the right-hand sidebar.

Built-In Templates¶

Many of the built-in templates work better if you set certain fields on your target or page definitions. Here's a list of those fields:

Page Templates¶

The following built-in templates represent full pages, so you can use them with the default_template: and template: settings in the config file or frontmatter. You can also derive your own templates from these templates using {% extends 'template' %} syntax.

When extending the default templates, you many of them have blocks you can replace. For the full list, see the templates directly.

Module Templates¶

The following built-in templates are partial modules you can use with {% include 'templatehere.html' %} blocks from other templates. Many of these pieces are used by the page templates above, as well:

Children Module¶

The following demonstrates how to use the children.html template to display a list of children of a page (including links):

{ % set parent_html = 'some-parent.html' %}
{ % set show_blurbs = True %}
{ % set depth = 3 %}
{ % include 'children.html' %}

You can omit any or all of the {% set ... %} statements to use the defaults:

Tree Nav Module¶

The following shows how to display a subset of the tree nav (starting with the file some_parent.html) instead of the full tree:

{ % set tree_top = pages|selectattr('html', 'defined_and_equalto', 'some_parent.html')|list|first %}
{ % include 'tree-nav.html' %}

Template Data¶

Dactyl provides the following information to templates, which you can access with Jinja's templating syntax (e.g. {{ target.display_name }}):