Nine Project Managers

    gulp-nunjucks-templates

    1.0.9 • Public • Published

    Build Status

    gulp-nunjucks-templates

    Render Nunjucks templates

    Issues with the output should be reported on the Nunjucks issue tracker.

    Install

    Install with npm

    npm install --save-dev gulp-nunjucks-templates
    

    Example

    var gulp = require('gulp');
    var nunjucks = require('gulp-nunjucks-templates');
    
    gulp.task('default', function () {
      return gulp.src('src/templates/*.html')
        .pipe(nunjucks({
          path: ['src/templates/'] // String or Array
        }))
        .pipe(gulp.dest('dist'));
    });

    Example with gulp data

    var gulp = require('gulp');
    var nunjucks = require('gulp-nunjucks-templates');
    var data = require('gulp-data');
    
    function getDataForFile(file) {
      return {
        example: 'data loaded for ' + file.relative
      };
    }
    
    gulp.task('default', function () {
    	return gulp.src('src/templates/*.html')
        .pipe(data(getDataForFile))
        .pipe(nunjucks({
          path: 'src/templates'
        }))
        .pipe(gulp.dest('dist'));
    });

    API

    Options

    Plugin accepts options object, which contain these by default:

    var defaults = {
      path: '.',
      ext: '.html',
      data: {},
      inheritExtension: false,
      envOptions: {
        watch: false
      },
      manageEnv: null,
      loaders: null
    };
    • path - Relative path to templates
    • ext - Extension for compiled templates, pass null or empty string if yo don't want any extension
    • data - Data passed to template
    • inheritExtension - If true, uses same extension that is used for template
    • envOptions - These are options provided for nunjucks Environment. More info here.
    • manageEnv - Hook for managing environment before compilation. Useful for adding custom filters, globals, etc. Example below
    • loaders - If provided, uses that as first parameter to Environment constructor. Otherwise, uses provided path. More info here

    For more info about nunjucks functionality, check https://mozilla.github.io/nunjucks/api.html and also a source code of this plugin.

    Install

    npm i gulp-nunjucks-templates

    DownloadsWeekly Downloads

    9

    Version

    1.0.9

    License

    MIT

    Unpacked Size

    58.9 kB

    Total Files

    24

    Last publish

    Collaborators

    • rowling7