Nunjucks to HTML
![npm version](https://badge.fury.io/js/nunjucks-to-html.svg)
Parse Nunjucks templates to HTML easily. You don't need Gulp nor Grunt to do it.
Keep your HTML clean and modularized by using a templating engine, like Nunjucks. Then, convert those files into HTML during your development process or even during production. This way, you can split your files, replace variables, etc... Why Nunjucks? Because it's heavily inspired by Jinja2 but written for Javascript environments.
Installation
Via npm:
npm i nunjucks-to-html
Via yarn:
yarn add nunjucks-to-html
Usage
Using this tool is as simple as installing it, and executing the following:
nunjucks-to-html
However, it's expected to be used in your package.json (in the "scripts" section):
"scripts": {
"build": "npm run build:html",
"build:html": "nunjucks-to-html"
},
"devDependencies": {
"nunjucks-to-html": "*"
}
Or importing it server side using:
const nunjucksToHTML = require('nunjucks-to-html');
CLI usage
Usage: nunjucks-to-html [sources] [flags...]
--baseDir <path> Base directory for the source files. Defaults to "".
--config <filepath> Filepath to the config file. Relative to cwd. Defaults to "nunjucks.config.js".
--dest <path> Path to the destination directory. Relative to cwd. Defaults to "public"
--ext <string> Extension for the destination file. Defaults to .html
--cwd <path> The path for the current working directory. Defaults to process.cwd().
--flatten <boolean> If present, flatten the source file name under the destination path. If absent, use the full source file name under the destination path. Defaults to false.
CLI examples
To parse all .njk
files and save them in public/
:
nunjucks-to-html
To parse all .njk
files in static/
and save them in public/
:
nunjucks-to-html --baseDir static
To parse .njk
and .html
files under the static/
directory and save them in public/static
:
nunjucks-to-html static/**/*.{njk,html}
To configure the destination path, use the --dest
flag:
nunjucks-to-html --dest my-destination
To configure Nunjucks using a config. file:
nunjucks-to-html
module.exports = {
"options": {
"data": "some/path/on/cwd.js",
beforeRender (nunjucksEnv, renderName, renderData) { let nunjucks = this; },
beforeWrite (destinationFilepath, renderResult) { let nunjucks = this; }
},
"configure": {
"path": undefined,
"options": {
"autoescape": true,
"throwOnUndefined": false,
}
},
"render": {
"name": undefined,
"context": {},
"callback": () => {}
}
};
To configure the name of the config file, use the --config
flag:
nunjucks-to-html --config njk.js
To call multiple jobs with different options, export an array of tasks:
nunjucks-to-html
module.exports = [{
"configure": {},
"render": {}
}, {
"configure": {},
"render": {}
}, ];
To change the file extension of the destination file, use the --ext
flag.
nunjucks-to-html --ext .html
To flatten the source file name under the destination path, use the --flatten
flag.
nunjucks-to-html --flatten
To change the current working directory, use the --cwd
flag:
nunjucks-to-html --cwd /var/www
Nodejs usage
The following are the default/supported parameters for this module:
const nunjucksToHtml = require('nunjucks-to-html');
nunjucksToHtml(['**/*.njk'], {
'config': 'nunjucks.config.js',
'dest': 'public',
'ext': '.html',
'baseDir': '',
'cwd': process.cwd(),
'flatten': false
}).then((results) => {})
.catch((error) => {});