Skip to content

TQI/grunt-nunjucks-json

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

grunt-nunjucks-json

Grunt plugin to compile Nunjucks templates to static HTML.

Getting Started

This plugin requires Grunt.

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-nunjucks-json --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-nunjucks-json');

The "nunjucks_json" task

Overview

In your project's Gruntfile, add a section named nunjucks_json to the data object passed into grunt.initConfig().

grunt.initConfig({
  nunjucks_json: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
})

Options

metadata

Type: String Default: metadata

nunjucksOptions

Type: Object Default: { trimBlocks: true, lstripBlocks: false, autoscape: true }

Usage Examples

grunt.initConfig({
  nunjucks_json: {
      default_options: {
        options: {
            metadata: 'templates/metadata',
            nunjucksOptions: {
                autoscape: true
            }
        },
        files: [{
          expand: true,
          flatten: true,
          src: ['templates/*.tpl'],
          dest: 'tmp/',
          ext: '.html'
        }]
      }
    },
})

page.js

module.exports = {
  title: "Olá",
  names: require('./partials/names.json')
};
.
├── Gruntfile.js
└── templates
    ├── metadata
    |   ├── partials
    |   |   └──names.json
    |   └── page.js
    └── page.tpl

Reference

Nunjucks

Jinja2 (Nunjucks Father)

Nunjucks Changelog

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

(Nothing yet)

License

Copyright (c) 2015 Daniel França. Licensed under the MIT license.

About

Grunt Nunjucks JSON

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 98.6%
  • HTML 1.4%