]> git.proxmox.com Git - rustc.git/blob - vendor/tera/README.md
New upstream version 1.55.0+dfsg1
[rustc.git] / vendor / tera / README.md
1 # Tera
2
3 [![Actions Status](https://github.com/Keats/tera/workflows/ci/badge.svg)](https://github.com/Keats/tera/actions)
4 [![Crates.io](https://img.shields.io/crates/v/tera.svg)](https://crates.io/crates/tera)
5 [![Docs](https://docs.rs/tera/badge.svg)](https://docs.rs/crate/tera/)
6 [![Gitter](https://badges.gitter.im/Tera-templates/community.svg)](https://gitter.im/Tera-templates/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
7
8 Tera is a template engine inspired by [Jinja2](http://jinja.pocoo.org/) and the [Django template language](https://docs.djangoproject.com/en/3.1/topics/templates/).
9
10 ```jinja2
11 <title>{% block title %}{% endblock title %}</title>
12 <ul>
13 {% for user in users %}
14 <li><a href="{{ user.url }}">{{ user.username }}</a></li>
15 {% endfor %}
16 </ul>
17 ```
18
19 It does not aim to be 100% compatible with them but has many of the Jinja2/Django filters and testers.
20
21 ## Documentation
22 API documentation is available on [docs.rs](https://docs.rs/crate/tera/).
23
24 Tera documentation is available on its [site](https://tera.netlify.app/docs).
25
26 ## Community
27 There's a gitter community chat (not managed/used by @Keats): https://gitter.im/Tera-templates/community
28
29 ## SemVer
30 This project follows SemVer only for the public API, public API here meaning functions appearing in the docs.
31 Some features, like accessing the AST, are also available but breaking changes in them can happen in any versions.