Go to file
2021-05-13 17:19:23 -07:00
.github rename default branch in files 2021-05-11 16:24:15 -07:00
artwork documentation style updates, added print css 2008-05-06 12:14:23 +02:00
docs rename default branch in files 2021-05-11 16:24:15 -07:00
examples/basic rename default branch in files 2021-05-11 16:24:15 -07:00
requirements Install sphinx 4.1-dev from git 2021-05-12 01:06:40 +02:00
scripts apply pyupgrade and f-strings 2020-02-05 08:44:15 -08:00
src/jinja2 mark top-level names as exported 2021-05-13 17:19:23 -07:00
tests rename default branch in files 2021-05-11 16:24:15 -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 pre-commit monthly 2021-05-11 07:05:21 -07:00
.readthedocs.yaml use rtd to build docs for prs 2021-02-16 08:41:40 -08:00
CHANGES.rst mark top-level names as exported 2021-05-13 17:19:23 -07:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2019-05-06 13:10:17 -04:00
CONTRIBUTING.rst rename default branch in files 2021-05-11 16:24:15 -07: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 update project links 2021-02-24 09:46:20 -08:00
setup.cfg add type annotations 2021-05-08 13:03:15 -07:00
setup.py update markupsafe minimum version 2021-05-11 14:21:06 -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