1.0.2 • Published 4 years ago

@danfraticiu/grunt-mjml v1.0.2

Weekly downloads
2
License
-
Repository
github
Last release
4 years ago

grunt-mjml

Grunt integration for mjml, the email template engine

Getting Started

This plugin requires Grunt ~1.0.1

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-mjml --save-dev

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

grunt.loadNpmTasks('grunt-mjml');

The "mjml" task

Options

Object of options that will be passed to the mjml2html function.

optionunitdescriptiondefault value
fontsobjectDefault fonts imported in the HTML rendered by HTMLSee in index.js
keepCommentsbooleanOption to keep comments in the HTML outputtrue
beautifybooleanOption to beautify the HTML outputfalse
minifybooleanOption to minify the HTML outputfalse
validationLevelstringAvailable values for the validator: 'strict', 'soft', 'skip''soft'
filePathstringPath of file, used for relative paths in mj-includes'.'

For more info: https://github.com/mjmlio/mjml/blob/master/README.md#inside-nodejs

Overview

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

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

Example

grunt.initConfig({
  mjml: {
    options: {},
    your_target: {
      files: [{
        expand: true,
        cwd: 'email-templates', // Src matches are relative to this path.
        src: ['**/*'], // Actual pattern(s) to match.
        dest: 'compiled-email-templates/',   // Destination path prefix.
        ext: '.html',   // Dest filepaths will have this extension.
        extDot: 'first'   // Extensions in filenames begin after the first dot
      }]
    }
  },
});

Release History

  • make MJML as Peer Dependencie
  • upgrade MJML Peer Dependencie to 3.x
  • Upgrade MJML peer Dependencie to 4.x
  • Support Yarn and npm 5.X