Ok, sorry, I like brief descriptions myself and I thought Jinja was kind of common knowledge (Jinja is the backbone of Sphinx, Jekyll, etc.). Also, could you put the contributing guidelines in CONTRIBUTING.md (https://github.com/blog/1184-contributing-guidelines) Jinja is a template engine written in Python. See http://jinja.pocoo.org/.

What went wrong

Sphinx (and Jekyll) templates are written using Jinja. A template might look something like this:

{% extends "layout.html" %}
{% block body %}
  <ul>
  {% for user in users %}
    <li><a href="{{ user.url }}">{{ user.username }}</a></li>
  {% endfor %}
  </ul>
{% endblock %}

I created an auto-formatter for my project to prevent messed up indents etc. I picked tidy-html5 as HTML formatter. When I formatted a repository that contained Sphinx templates (http://sphinx-doc.org/, this is a documentation generator written in Python that uses Jinja as template backend), it went wrong.

Tidy version

5.0.0

Reproduce

{% extends "layout.html" %}
{% block body %}
  <ul>
  {% for user in users %}
    <li><a href="{{ user.url }}">{{ user.username }}</a></li>
  {% endfor %}
  </ul>
{% endblock %}

Output from tidy -indent

<!DOCTYPE html>
<html>
<head>
  <meta name="generator" content=
  "HTML Tidy for HTML5 for Linux version 5.0.0">
  <title></title>
</head>
<body>
  {% extends "layout.html" %} {% block body %}
  <ul>
    <li style="list-style: none">{% for user in users %}</li>
    <li>
      <a href="{{%20user.url%20}}">{{ user.username }}</a>
    </li>
    <li style="list-style: none">{% endfor %}</li>
  </ul>{% endblock %}
</body>
</html>

Obviously, the template itself is not valid HTML. And often, the template file only describes a fragment of the page like in this example. Note that this is also the case for web components (used by Polymer and very popular right now, you can find more about this by Googling it). Do you think you could add options to tidy-html5 that allows me to format a Jinja template? (and html imports, which will have similar problems).

Do not mess up Jinja templates #310

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions