Admix.js

ES6 template renderer

import admix from "admix";

const template = admix("Hello, <%= someTag %>!");

template({someTag: "world"}); // "Hello, world!"

Quality and Compatibility

Every build and release is automatically tested on the following platforms:

If your platform is not listed above, you can test your local environment for compatibility by copying and pasting the following commands into your terminal:

npm install admix
cd node_modules/admix
gulp test-local

Installation

Copy and paste the following command into your terminal to install Admix:

npm install admix --save

Import / Require

// ES6
import admix from "admix";

// ES5
var admix = require("admix");

// Require.js
define(["require"] , function (require) {
    var admix = require("admix");
});

Getting Started

With admix, you provide a template in string format containing tags delimited by <%= and %>.

import admix from "admix";

const template = admix("Hello, <%= someTag %>!");

template({someTag: "world"}); // "Hello, world!"

More insights

In order to say something, you should know that admix() ... (add your test here)

How to Contribute

See something that could use improvement? Have a great feature idea? We listen!

You can submit your ideas through our issues system, or make the modifications yourself and submit them to us in the form of a GitHub pull request.

We always aim to be friendly and helpful.

Running Tests

It's easy to run the test suite locally, and highly recommended if you're using Admix.js on a platform we aren't automatically testing for.

npm test