❤
npm
Sign UpSign In

gulp-mjml

4.0.2 • Public • Published

Gulp MJML

Add MJML to your gulp workflow!

Usage:

With an MJML file named test.mjml, render your emails to an html folder:

const gulp = require('gulp')
const mjml = require('gulp-mjml')
 
gulp.task('default', function () {
  return gulp.src('./test.mjml')
    .pipe(mjml())
    .pipe(gulp.dest('./html'))
})

If you have custom components linked to your own mjmlEngine, you can pass it to the gulp task so it uses your engine to render the html:

const gulp = require('gulp')
const mjml = require('gulp-mjml')
 
// Require your own components if needed, and your mjmlEngine (possibly with options)
// require('./components')
const mjmlEngine = require('mjml')
 
gulp.task('default', function () {
  return gulp.src('./test.mjml')
    .pipe(mjml(mjmlEngine, {minify: true}))
    .pipe(gulp.dest('./html'))
})

If you'd like to get validation errors and , use strict and a custom error handler function. Note that using strict will not render the file in case of error:

const gulp = require('gulp')
 
const mjml = require('gulp-mjml')
const mjmlEngine = require('mjml')
 
function handleError (err) {
  console.log(err.toString());
  this.emit('end');
}
 
gulp.task('default', function () {
  return gulp.src('./test.mjml')
    .pipe(mjml(mjmlEngine, {validationLevel: 'strict'}))
    .on('error', handleError)
    .pipe(gulp.dest('./html'))
})

Readme

Keywords

Package Sidebar

Install

npm i gulp-mjml

Weekly Downloads

3,842

Version

4.0.2

License

MIT

Unpacked Size

161 kB

Total Files

7

Last publish

Collaborators

  • iryusa
  • kmcb
  • loeck
  • meriadec
  • mjmlio
  • ngarnier
Try on RunKit
Report malware