Jade Browser

Middleware for express/connect and/or static file generator to expose jade templates to the web browser. It provides a few additional features like express-like render function with partial handling.

var express = require('express')
  , jade_browser = require('jade-browser')
  , app = express.createServer();
  
app.use(jade_browser(url_endpoint, template_dir, options));

Installation

$ npm install jade-browser

Features

Jade templates are served as compiled functions. * either as middleware or pre-cached and served from a public directory
- removes browser compatibility issues
- increases speed of template execution
- reduces file transfer size
ability to minify output
option to attach cache control
provides helpers for handling rendering/partials just like express.
relative path handling even from within partials.
ability to completely namespace to avoid any naming collisions on the browser.
partials inherit parent locals

Usage

In Node.js

As middleware jade-browser is simple to use.

var express = require('express')
  , jade_browser = require('jade-browser')
  , app = express.createServer();

// use jade-browser as middleware
app.use(jade_browser.middleware('/js/templates.js', '**', options));

Or, configure to add static file caching -- with or without express/connect.

var jade_browser = require('jade-browser')

// this will generate a file at this location: staticRoot + '/js/templates.js'
jade_browser.cache('/js/templates.js', '**', 
	{root: 'some/directory/with/views', staticRoot: __dirname  + '/public'});

// or, configure the file watcher and add static file caching
// you'll need to manually create the folder where the files should live
// to compile, just save one of the files listed in the directory. 
if (env === 'development') {
	jade_browser.watch('/js/templates.js', '**', 
		{root: 'some/directory/with/views', staticRoot: __dirname  + '/public'});
}

Params

filename The filename of the resulting compiled templates file
patterns A single string or array of patterns used to glob for template files
options Options object, see below (optional)

Options

root The root of the views (default: __dirname)
namespace Namespace for the browser (default: 'jade')
minify Minifies the output (default: false; If enabled and using caching, '-min.js' file is automatically created)
maxAge Time in seconds to cache the results (default: 86400)
cacheRoot The file system path where compiled templates are placed ()

Browser

jade.render('path/to/template', { values: for_template });

For direct access (for templates that have no need for partials).

jade.templates['path/to/template.jade'](locals);

Note: With render '.jade' extension is not required. Relative paths can be used in templates and in render function.

jade.render('path/../to/../test');

Credit

Large amounts of this code is inspired by TJ. Parts of express-expose and internal parts of express are recycled to make this happen.

Contributors

Nathan White (nw)
Adrian Bravo (adrianbravo)
Conner Petzold (cpetzold)

License

(The MIT License)

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.

nl0/jade-browser