README.md

musdash.js - Stupidly quick logic-less {{mustache}} templates for JavaScript

musdash.js is an implementation of the Mustache template system for JavaScript.

musdash.js was designed to be extremely fast at compiling and parsing {{mustache}} templates and is almost completely compatible with mustache.js except for a few little things.

Usage

Here is an example of how to use musdash.js:

var view = {
	data: [ 
		{ first: "Jane", last: "Doe" }, 
		{ first: "Joe", last: "Blogs" }
	],
	bold: function( render, text )
	{
		return '<b>' + render( text ) + '</b>';
	}
};

var template = Musdash.compile( '<ul>{{#data}}<li>{{#bold}}{{first}}{{/bold}} {{last}}</li>{{/data}}</ul>' );
var output = template.parse( view /*, optional partials parameter */ );

// `template` can be used as many times as necessary to avoid re-compiling (even though compiling is super fast anyway)

Links

Comparison of speed against mustache.js

Test cases

Features

musdash.js currently supports all mustache features except the 'Set Delimiter' feature.

See the mustache manual for more information.

musdash.js adds some utility variables which can be used within arrays, '_i' refers to the current index of the array (it is 1-indexed for convenience i.e. 1,2,3 not 0,1,2) and '_c' refers to the total number of items in the array

var view = {
	data: [ 
		{ first: "Jane", last: "Doe" }, 
		{ first: "Joe", last: "Blogs" }
	],
	separator: function()
	{
		return (this._i != this._c) ? ", " : "";
	}
};

var template = Musdash.compile( '{{#data}}{{_i}}. {{first}} {{last}}{{separator}}{{/data}}' );
var output = template.parse( view );

// Outputs "1. Jane Doe, 2. Joe Blogs";

mustache.js Compatibility

musdash.js has slightly different syntax to mustache.js see demos for example.

Building

mustdash.js comes with an ant build script, which at the moment simply compresses the source with YUI Compressor.

Simple run the 'ant' command in the project directory and the minified version will be placed in 'build'.

Note

musdash.js is still an infant and care should be taken using it in a production environment.