Skip to content

Latest commit

 

History

History
72 lines (46 loc) · 1.63 KB

README.md

File metadata and controls

72 lines (46 loc) · 1.63 KB
Raw

Laravel Mix MJML

A Laravel Mix plugin to compile MJML files.

Installation

This package can be installed through NPM:

npm install -D laravel-mix-mjml

Upgrading to v2.0.0

Please review the features and breaking changes documented in the release notes.

Basic Usage

// webpack.mix.js
const mix = require('laravel-mix');
require('laravel-mix-mjml');

mix.mjml();

API

The registered mjml plugin has the following signature:

mix.mjml(entry, output[, options]);

entry

Type: String
Default: "resources/mail"

The path where the MJML files are located. Can be a path to a specific file, a path to a directory, or a glob string.

output

Type: String
Default: "resources/views/mail"

The path where the compiled files should be outputted to. Note: This path will be resolved relative to your root path!

options.extension

Type: String
Default: ".blade.php"

The extension to use when outputting the compiled files. Ignored if a specific file path is passed as the output path.

options.mjmlOptions

Type: Object
Default:

{
    minify: false,
    beautify: true,
    filePath: '/path/to/input/file',
}

The options to pass to the MJML compiler. Please review the MJML documetation which options are accepted here.

License

The MIT License (MIT). Please see License file for more information.