Go to file
David Lord 28f12c020e
Merge pull request #1112 from pallets/include-syntax-error-source
TemplateSyntaxError from included template has source
2019-12-03 13:25:57 -08:00
.github Improve issue template 2017-01-09 17:37:18 +01:00
artwork documentation style updates, added print css 2008-05-06 12:14:23 +02:00
docs use "Jinja" instead of "Jinja2" 2019-10-23 13:35:49 -07:00
examples Use print() function in both Python2 and Python 3 2019-10-27 13:05:59 +01:00
ext Use print() function in both Python2 and Python 3 2019-10-27 13:05:59 +01:00
jinja2 TemplateSyntaxError from included template has source 2019-12-03 13:22:10 -08:00
scripts Use print() function in both Python2 and Python 3 2019-10-27 13:05:59 +01:00
tests TemplateSyntaxError from included template has source 2019-12-03 13:22:10 -08:00
.azure-pipelines.yml switch tests to azure pipelines 2019-07-20 12:44:26 -07:00
.gitignore don't finalize TemplateData nodes 2019-10-12 21:25:48 -07:00
CHANGES.rst TemplateSyntaxError from included template has source 2019-12-03 13:22:10 -08:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2019-05-06 13:10:17 -04:00
LICENSE.rst update project metadata 2019-10-04 11:17:12 -07:00
MANIFEST.in update project metadata 2019-10-04 11:17:12 -07:00
README.rst update project metadata 2019-10-04 11:17:12 -07:00
setup.cfg update project metadata 2019-10-04 11:17:12 -07:00
setup.py Merge branch '2.10.x' 2019-10-04 11:59:18 -07:00
tox.ini fix tox docs build 2019-07-26 15:17:58 -07:00

Jinja
=====

Jinja is a fast, expressive, extensible templating engine. Special
placeholders in the template allow writing code similar to Python
syntax. Then the template is passed data to render the final document.

It includes:

-   Template inheritance and inclusion.
-   Define and import macros within templates.
-   HTML templates can use autoescaping to prevent XSS from untrusted
    user input.
-   A sandboxed environment can safely render untrusted templates.
-   AsyncIO support for generating templates and calling async
    functions.
-   I18N support with Babel.
-   Templates are compiled to optimized Python code just-in-time and
    cached, or can be compiled ahead-of-time.
-   Exceptions point to the correct line in templates to make debugging
    easier.
-   Extensible filters, tests, functions, and even syntax.

Jinja's philosophy is that while application logic belongs in Python if
possible, it shouldn't make the template designer's job difficult by
restricting functionality too much.


Installing
----------

Install and update using `pip`_:

.. code-block:: text

    $ pip install -U Jinja2

.. _pip: https://pip.pypa.io/en/stable/quickstart/


In A Nutshell
-------------

.. code-block:: jinja

    {% extends "base.html" %}
    {% block title %}Members{% endblock %}
    {% block content %}
      <ul>
      {% for user in users %}
        <li><a href="{{ user.url }}">{{ user.username }}</a></li>
      {% endfor %}
      </ul>
    {% endblock %}


Links
-----

-   Website: https://palletsprojects.com/p/jinja/
-   Documentation: https://jinja.palletsprojects.com/
-   Releases: https://pypi.org/project/Jinja2/
-   Code: https://github.com/pallets/jinja
-   Issue tracker: https://github.com/pallets/jinja/issues
-   Test status: https://dev.azure.com/pallets/jinja/_build
-   Official chat: https://discord.gg/t6rrQZH