Go to file
2021-04-25 08:11:17 -07:00
.github cache mypy in ci 2021-02-24 09:49:31 -08:00
artwork documentation style updates, added print css 2008-05-06 12:14:23 +02:00
docs unique links for filters, tests, globals 2021-04-13 10:36:11 -07:00
examples/basic apply pyupgrade and f-strings 2020-02-05 08:44:15 -08:00
requirements update requirements 2021-04-16 08:17:55 -07:00
scripts apply pyupgrade and f-strings 2020-02-05 08:44:15 -08:00
src/jinja2 release version 3.0.0rc2 2021-04-25 08:08:40 -07:00
tests deprecate legacy resolve mode 2021-04-11 23:53:59 -07:00
.editorconfig add EditorConfig 2020-05-23 13:23:49 -07:00
.gitignore Setup mypy 2020-07-28 22:32:34 +01:00
.pre-commit-config.yaml update deprecated pre-commit hook 2021-04-16 08:18:09 -07:00
.readthedocs.yaml use rtd to build docs for prs 2021-02-16 08:41:40 -08:00
CHANGES.rst deprecate legacy resolve mode 2021-04-11 23:53:59 -07:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2019-05-06 13:10:17 -04:00
CONTRIBUTING.rst simplify dev install command 2021-02-08 11:57:06 -08:00
LICENSE.rst standardize license 2019-07-17 08:01:46 -07:00
MANIFEST.in use pip-compile to pin dev requirements 2020-05-18 15:25:33 -07:00
README.rst update project links 2021-02-24 09:46:20 -08:00
setup.cfg move version to setup.cfg 2021-02-24 09:50:00 -08:00
setup.py update minimum install requirements 2021-04-16 08:21:12 -07:00
tox.ini consistent typing config 2021-02-24 09:49:12 -08: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 %}


Donate
------

The Pallets organization develops and supports Jinja and other popular
packages. In order to grow the community of contributors and users, and
allow the maintainers to devote more time to the projects, `please
donate today`_.

.. _please donate today: https://palletsprojects.com/donate


Links
-----

-   Documentation: https://jinja.palletsprojects.com/
-   Changes: https://jinja.palletsprojects.com/changes/
-   PyPI Releases: https://pypi.org/project/Jinja2/
-   Source Code: https://github.com/pallets/jinja/
-   Issue Tracker: https://github.com/pallets/jinja/issues/
-   Website: https://palletsprojects.com/p/jinja/
-   Twitter: https://twitter.com/PalletsTeam
-   Chat: https://discord.gg/pallets