grunt-nunjucks-json
v0.1.1
Published
Grunt plugin to compile Nunjucks templates to static HTML.
Downloads
9
Readme
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
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.