mjmlio/vscode-mjml

MJML

This is a fork of original @attilabuti VSC extension : https://github.com/attilabuti/vscode-mjml

MJML preview, lint, compile for Visual Studio Code.

Features

• Live preview for MJML files. Preview updates as you type.
• Inline errors (squiggle underlines). Linter based on atom-linter-mjml.
• Export HTML file from MJML.
• Copy the result HTML to clipboard.
• Send email with Nodemailer or Mailjet.
• Code snippets for MJML. Based on mjml-syntax.
• Fetch official templates. Based on email-templates.
• Beautify MJML code.
• MJML syntax highlight. Based on mjml-syntax.
• Built-in MJML documentation with Try it live support.

It looks like this

Installation

Press F1, type ext install vscode-mjml.

Usage

Start command palette (with Ctrl+Shift+P or F1) and start typing MJML.

Available commands

The following command is available:

• MJML: Beautify or Format Document Beautify MJML code.
• MJML: Copy HTML Copy the result HTML to clipboard.
• MJML: Export HTML Export HTML file from MJML.
• MJML: Open Preview to the Side Opens a preview in a column alongside the current document.
• MJML: Send Email Send email with Nodemailer or Mailjet.
• MJML: Template Fetch official templates.
• MJML: Documentation open the MJML documentation.
• MJML: Search in MJML documentation search for the selected mj-element in the MJML documentation.
• MJML: Version Shows the version of MJML.

Settings

Include security settings (mjml.allowIncludes and mjml.includePath)

MJML 5 disables include processing by default for security.

• Set mjml.allowIncludes to true to enable <mj-include> processing.
• Keep mjml.allowIncludes as false (default) to ignore all includes.
• Use mjml.includePath to allow includes outside the current template base path.

When includes are enabled:

• Includes in the same folder (or subfolders) as the current MJML file are allowed.
• Includes outside that folder are denied unless the target folder is listed in mjml.includePath.

mjml.includePath accepts absolute paths or workspace-relative paths.

Correct JSON example:

{
    "mjml.allowIncludes": true,
    "mjml.includePath": ["resources/templates", "shared/partials"]
}

Settings UI note:

• In the Settings UI, add each include path as a separate array item.
• Do not paste a full JSON array as one item (for example "[\"resources/templates\"]").

Scope note:

• Workspace settings override User settings.
• If include behavior is unexpected, check both User and Workspace values for mjml.allowIncludes and mjml.includePath.

Snippets

Each snippet can be triggered by its keyword (e.g. mjbody) or by typing the opening tag directly (e.g. <mj-body). Both trigger the same completion.

Nodemailer configuration

Please see the Nodemailer documentation for more information.

Gmail

"mjml.nodemailer": {
    "service": "Gmail",
    "auth": {
        "user": "[email protected]",
        "pass": "password"
    }
}

Mailtrap

"mjml.nodemailer": {
    "host": "smtp.mailtrap.io",
    "port": 2525,
    "auth": {
        "user": "username",
        "pass": "password"
    }
}

Ethereal

"mjml.nodemailer": {
    "host": "smtp.ethereal.email",
    "port": 587,
    "auth": {
        "user": "[email protected]",
        "pass": "password"
    }
}

Change Log

https://github.com/mjmlio/vscode-mjml/blob/master/CHANGELOG.md

Issues

Submit the issues if you find any bug or have any suggestion.

Contribution

Fork the repo and submit pull requests.

Contributors

Main Author: Attila Buti (@attilabuti)

A big thanks to the people that have contributed to this project:

• Christian Brevik (@cbrevik) - contributions)
• Kevin Oliveira (@kvnol) - contributions)
• Joshua Skrzypek (@jskrzypek) - contributions)

License

This extension is licensed under the [MIT License][license-url].