Giter VIP home page Giter VIP logo

assemble-nunjucks's Introduction

assemble-nunjucks NPM version NPM downloads Build Status

Adds nunjucks support to assemble, with some assemble-specific conveniences.

Usage

Add nunjucks support to assemble:

var engine = require('assemble-nunjucks');
var assemble = require('assemble');
app.use(engine());

Examples

Use with .render

app.page({path: 'foo.njk', contents: 'this is {{name}}'});

// render a view
app.render('foo.njk', {name: 'Foo'}, function(err, res) {
  console.log(res.contents.toString());
  //=> 'this is Foo'
});

Use with .renderFile

app.src('*.njk')
  .pipe(app.renderFile())
  .on('data', function(file) {
    console.log(file.contents.toString());
    //=> 'this is Foo'
  });

What does this do?

Adds support for nunjucks

Note that you can pass your own env on the options, so you can work directly with the Nunjucks API if you need to do something that isn't listed here.

Pull requests are also welcome!

Engine

Registers engine-nunjucks to the njk extension.

This means that assemble will automatically use this engine to render templates with the extension .njk. To force assemble to use this engine for rendering all templates, do:

app.option('engine', 'njk');

Filters

Allows you to register a nunjucks filter using:

app.helper('foo', function(str) {
  // do stuff to str
  return str;
});
// or
app.addFilter('foo', function(str) {
  // do stuff to str
  return str;
});

Register multiple filters with:

app.helpers({
  foo: function() {},
  bar: function() {},
  baz: function() {}
});
// or
app.addFilters({
  foo: function() {},
  bar: function() {},
  baz: function() {}
});

Async Filters

Allows you to register an async nunjucks filter using:

app.asyncHelper('foo', function(str) {
  // do stuff to str
  return str;
});
// or
app.asyncAddFilter('foo', function(str) {
  // do stuff to str
  return str;
});

Register multiple filters with:

app.asyncHelpers({
  foo: function() {},
  bar: function() {},
  baz: function() {}
});
// or
app.asyncAddFilters({
  foo: function() {},
  bar: function() {},
  baz: function() {}
});

Customization

Optionally pass your own nunjucks (module):

app.use(engine({nunjucks: require('nunjucks')}));

Optionally pass your own env:

var nunjucks = require('nunjucks');
var env = new nunjucks.Environment();
app.use(engine({env: env}));

About

Related projects

  • engine-nunjucks: More comprehensive consolidate-style engine support for nunjucks. Should work with express, assemble, verb, generate, update… more | homepage
  • generate: Command line tool and developer framework for scaffolding out new GitHub projects. Generate offers the… more | homepage
  • update: Be scalable! Update is a new, open source developer framework and CLI for automating updates… more | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

License

Copyright © 2016, Jon Schlinkert. Released under the MIT license.


This file was generated by verb, v0.9.0, on July 26, 2016.

assemble-nunjucks's People

Contributors

jonschlinkert avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.