• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1Jinja
2=====
3
4Jinja is a fast, expressive, extensible templating engine. Special
5placeholders in the template allow writing code similar to Python
6syntax. Then the template is passed data to render the final document.
7
8It includes:
9
10-   Template inheritance and inclusion.
11-   Define and import macros within templates.
12-   HTML templates can use autoescaping to prevent XSS from untrusted
13    user input.
14-   A sandboxed environment can safely render untrusted templates.
15-   AsyncIO support for generating templates and calling async
16    functions.
17-   I18N support with Babel.
18-   Templates are compiled to optimized Python code just-in-time and
19    cached, or can be compiled ahead-of-time.
20-   Exceptions point to the correct line in templates to make debugging
21    easier.
22-   Extensible filters, tests, functions, and even syntax.
23
24Jinja's philosophy is that while application logic belongs in Python if
25possible, it shouldn't make the template designer's job difficult by
26restricting functionality too much.
27
28
29Installing
30----------
31
32Install and update using `pip`_:
33
34.. code-block:: text
35
36    $ pip install -U Jinja2
37
38.. _pip: https://pip.pypa.io/en/stable/getting-started/
39
40
41In A Nutshell
42-------------
43
44.. code-block:: jinja
45
46    {% extends "base.html" %}
47    {% block title %}Members{% endblock %}
48    {% block content %}
49      <ul>
50      {% for user in users %}
51        <li><a href="{{ user.url }}">{{ user.username }}</a></li>
52      {% endfor %}
53      </ul>
54    {% endblock %}
55
56
57Donate
58------
59
60The Pallets organization develops and supports Jinja and other popular
61packages. In order to grow the community of contributors and users, and
62allow the maintainers to devote more time to the projects, `please
63donate today`_.
64
65.. _please donate today: https://palletsprojects.com/donate
66
67
68Links
69-----
70
71-   Documentation: https://jinja.palletsprojects.com/
72-   Changes: https://jinja.palletsprojects.com/changes/
73-   PyPI Releases: https://pypi.org/project/Jinja2/
74-   Source Code: https://github.com/pallets/jinja/
75-   Issue Tracker: https://github.com/pallets/jinja/issues/
76-   Website: https://palletsprojects.com/p/jinja/
77-   Twitter: https://twitter.com/PalletsTeam
78-   Chat: https://discord.gg/pallets
79