Skip to content
This repository
Fetching contributors…

Octocat-spinner-32-eaf2f5

Cannot retrieve contributors at this time

file 79 lines (54 sloc) 3.016 kb

Swig

Swig is a fast, Django-like template engine for node.js.

Features

  • Incredibly fast!
  • Express compatible.
  • Object-Oriented template inheritance.
  • Apply filters and transformations to output in your templates.
  • Automatically escapes all output.
  • Lots of iteration and conditionals supported.
  • Extendable and customizable.

Installation

npm install swig

Documentation

All documentation can be viewed online. Documentation Table of Contents

Basic Example

Template code

<h1>Example</h1>
{% for name in names %}
  <p>
    {{ forloop.counter }}
    {# This is a comment #}
    {{ name }}{% if name == "Django" %} Reinhardt{% endif %}
  </p>
{% endfor %}

node.js code

var template  = require('Swig');
var tmpl = template.fromFile("/path/to/template.html");
console.log(tmpl.render({names: ["Duke", "Django", "Louis"]}));

Output

<h1>Example</h1>
  <p>
    1
    Duke
  </p>
  <p>
    2
    Django Reinhardt
  </p>
  <p>
    3
    Louis
  </p>

How it works

Swig reads template files and translates them into javascript functions using the Function constructor. When we later render a template we call the evaled function passing a context object as an argument. This makes the rendering very fast. The template tags are defined as strings of Javascript code - which is a bit ugly, but there are helpers that will make writing tags easier for you.

Template syntax

While Swig is inspired by the Django template syntax, there are a few differences:

  • Filters have a different syntaxt.
  • Some tags are missing or have different syntax.
  • Some extra tags are available.

License

Copyright (c) 2010-2011 Paul Armstrong, Dusko Jordanovski

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Something went wrong with that request. Please try again.