twing

Twing

First-class JavaScript Twig compiler

Prerequisites

Twing needs at least node.js 16.0.0 to run.

Installation

The recommended way to install Twing is via npm:

npm install twing --save

Documentation

See the Twing website for documentation.

Basic API Usage

import {createEnvironment, createArrayLoader} from "twing";

const loader = createArrayLoader({
    'index.twig': 'Everybody loves {{ name }}!'
});

const environment = createEnvironment(loader);

environment.render('index.twig', {name: 'Twing'}).then((output) => {
    // output contains "Everybody loves Twing!"
});

Script tag

Use cdnjs to include Twing in your HTML document.

Once loaded by the browser, Twing is available under the global Twing variable.

Related packages

• gulp-twing: Compile Twig templates with gulp. Build upon Twing.
• twing-loader: Webpack loader that compiles Twig templates using Twing.

License

Copyright © 2018 Eric MORAND. Released under the 2-Clause BSD License.