Go to file
Kevin ff7b3202fd Start working on new AST parser
This parser will take the Tatsu-generated AST and generate a compatible
Jinja AST from it. This should allow us to refine the grammar to
generate a better AST and also verify that it is producing comparable
Jinja ASTs that can be used by the current compiler.
2020-05-10 10:29:48 -04: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 remove vim syntax file 2020-04-19 08:55:59 -07:00
examples/basic apply pyupgrade and f-strings 2020-02-05 08:44:15 -08:00
scripts apply pyupgrade and f-strings 2020-02-05 08:44:15 -08:00
src/jinja2 Merge branch '2.11.x' 2020-04-13 09:26:39 -07:00
tests Merge branch '2.11.x' 2020-04-13 09:26:39 -07:00
.azure-pipelines.yml remove unsupported test envs 2020-01-30 09:28:40 -08:00
.gitignore Start working on new AST parser 2020-05-10 10:29:48 -04:00
.pre-commit-config.yaml add pyupgrade pre-commit hook 2020-02-05 08:44:19 -08:00
CHANGES.rst Merge branch '2.11.x' 2020-04-13 09:26:39 -07:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2019-05-06 13:10:17 -04:00
grammar.ebnf Support filters on all variables 2020-05-09 22:23:32 -04:00
LICENSE.rst standardize license 2019-07-17 08:01:46 -07:00
MANIFEST.in remove vim syntax file 2020-04-19 08:55:59 -07:00
new_parser.py Start working on new AST parser 2020-05-10 10:29:48 -04:00
README.rst Revert "rename imports to jinja" 2020-01-26 21:12:52 -08:00
setup.cfg stop building universal wheel 2020-02-05 08:37:40 -08:00
setup.py stop building universal wheel 2020-02-05 08:37:40 -08:00
test_tatsu.py Start working on new AST parser 2020-05-10 10:29:48 -04:00
test_template.jinja Start working on new AST parser 2020-05-10 10:29:48 -04:00
tox.ini remove unsupported test envs 2020-02-05 08:37:40 -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 %}


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