webatvantage-webpack-mjml-plugin v2.2.0

Webatvantage Webpack MJML Plugin

Webpack plugin for converting MJML files to HTML. Forked from TDE Webpack MJML Plugin.

Install

npm install --save-dev webatvantage-webpack-mjml-plugin

Usage

In your webpack.config.js

const MjmlPlugin = require('webatvantage-webpack-mjml-plugin');

module.exports = {
    // ...
    plugins: [
        new MjmlPlugin(paths.MJML, {
            extension: '.twig',
            outputPath: path.resolve(__dirname, 'path/to/mjml'),
        }),
    ]
};

API:

// webpack.config.js

module.exports = {
    plugins: [
        new MjmlPlugin(inputPath, {
            extension: options.extension,
            outputPath: options.outputPath,
            // MJML options (https://documentation.mjml.io/#inside-node-js)
            filePath: path.resolve(__dirname, 'path/to/file'),
            keepComments: false,
        }),
    ]
}

inputPath

Type: String

The path where MJML files are located

options.extension

Type: String Default: ".html"

The default output extension

options.outputPath

Type: String Default: ""

The path where HTML files should be written to

options.watchPath

Type: String Default: ""

The path to the root of the mjml directory. This option allows re-compilation when a partial (mj-include) changes. With the directory structure below:

project

└─── src
  │
  └─── mjml
    │
    └─── partials
    │     │  head.mjml
    │     │  ...
    │
    └─── views
           │   newsletter.mjml
           │   ...

We could use the following configuration to recompile views whenever partials change.

module.exports = {
    plugins: [
        new MjmlPlugin(path.resolve(__dirname, 'src/mjml/views'), {
          watchPath: path.resolve(__dirname, 'src/mjml'),
        }),
    ]
}

MJML options

Pass optional options to the mjml2html function List of available options: https://documentation.mjml.io/#inside-node-js

License

MIT © TDE MIT © Webatvantage