Go to file
2024-01-10 15:01:45 -08:00
.github use trusted publishing 2024-01-10 15:01:45 -08:00
artwork documentation style updates, added print css 2008-05-06 12:14:23 +02:00
docs remove unused links 2023-06-01 08:09:59 -07:00
examples/basic rename default branch in files 2021-05-11 16:24:15 -07:00
requirements update dependencies 2023-06-27 07:36:34 -07:00
scripts address flake8 findings 2023-03-07 06:55:44 -08:00
src/jinja2 update pre-commit hooks 2024-01-10 14:33:07 -08:00
tests Make nested-trans-block exceptions nicer 2024-01-10 14:27:09 -08:00
.editorconfig add EditorConfig 2020-05-23 13:23:49 -07:00
.flake8 move and update flake8 config 2023-01-20 11:07:11 -08:00
.gitignore Setup mypy 2020-07-28 22:32:34 +01:00
.pre-commit-config.yaml update pre-commit hooks 2024-01-10 14:33:07 -08:00
.readthedocs.yaml pin os and python version in rtd build 2021-12-26 16:10:04 -07:00
CHANGES.rst Make nested-trans-block exceptions nicer 2024-01-10 14:27:09 -08:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2019-05-06 13:10:17 -04:00
CONTRIBUTING.rst Improve the contributing guide 2021-05-25 08:51:55 +08:00
LICENSE.rst standardize license 2019-07-17 08:01:46 -07:00
MANIFEST.in fix py.typed in manifest 2021-05-10 06:53:52 -07:00
README.rst remove unused links 2023-06-01 08:09:59 -07:00
setup.cfg update dependencies 2023-06-27 07:36:34 -07:00
setup.py update markupsafe minimum version 2021-05-11 14:21:06 -07:00
tox.ini simplify tox config 2023-06-27 08:01:19 -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/getting-started/


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/
-   Chat: https://discord.gg/pallets