Piglet: Fast Python Template Engine
====================================

Documentation contents
----------------------

.. _toc:

.. toctree::
    :maxdepth: 2

    This page <index>
    template-reuse
    python-api
    i18n
    directives
    builtin-functions
    texttemplates
    changelog

.. _overview:

Overview of Piglet templates
--------------------------------

Piglet is a templating engine that compiles templates to fast python
byte code. Piglet HTML templates look like this:

.. code:: html

    <py:extends href="base.html">
        <py:block name="content">
            Hello ${name}!
            <ul>
                <li py:for="item in bag">$item</li>
            </ul>
        </py:block>
    </py:extends>

Learn more about Piglet's :doc:`template directives <directives>`,
or :doc:`how to use piglet's Python API <python-api>`.

Piglet also has a :doc:`text mode <texttemplates>`:

.. code:: text

    {% extends "base.txt" %}
        {% block "content" %}
            Hello ${name}!
            {% for item in bag %}
            - $item
            {% end %}
        {% end %}
    {% end %}

Piglet also contains flexible :doc:`translation directives <i18n>`
and is designed to work for internationalized applications.

Read more in the :ref:`documentation contents <toc>`.