Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vergissberlin/node-red-contrib-mjml

Node for NodeRED to create professional looking emails with MJML.
https://github.com/vergissberlin/node-red-contrib-mjml

node node-red

Last synced: 10 days ago
JSON representation

Node for NodeRED to create professional looking emails with MJML.

Awesome Lists containing this project

README

        

# node-red-contrib-mjml
[![NPM monthly downloads](https://img.shields.io/npm/dm/@vergissberlin/node-red-contrib-mjml.svg)](https://www.npmjs.com/package/@vergissberlin/node-red-contrib-mjml)
[![Crowdin](https://badges.crowdin.net/node-red-contrib-mjml/localized.svg)](https://crowdin.com/project/node-red-contrib-mjml)
[![GitHub issues](https://img.shields.io/github/issues/vergissberlin/node-red-contrib-mjml)](https://github.com/vergissberlin/node-red-contrib-mjml/issues)
[![GitHub license](https://img.shields.io/github/license/vergissberlin/node-red-contrib-mjml)](https://github.com/vergissberlin/node-red-contrib-mjml/blob/main/LICENSE)

Node for NodeRED to create emails with MJML language. It provides a NodeRED node to parse your template and output HTML.

## Installation

Change directory to your NodeRED installation and issue:

```shell
npm install @vergissberlin/node-red-contrib-mjml
```

**OR** go to your pallet settings in your NodeRED admin ui and search for "mjml".

## Getting Started

In this repo there is `example-flow.json`. You can import that into a NodeRED workspace and it will provide a template
for getting working with the MJML node.

![Example flow](docs/flow.png)

## Basic template example

In this section, you're going to learn how to code a basic email template using MJML.

```xml








My Company









Slogan here

Promotion







My Awesome
Text


Lorem ipsum dolor sit amet, consectetur adipiscing elit.
Proin rutrum enim eget magna efficitur, eu semper augue semper.
Aliquam erat volutpat. Cras id dui lectus. Vestibulum sed
finibus lectus, sit amet suscipit nibh. Proin nec commodo purus.
Sed eget nulla elit. Nulla aliquet mollis faucibus.

Learn more

















Find amazing places


Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin rutrum enim eget
magna efficitur, eu semper augue semper. Aliquam erat volutpat. Cras id dui lectus. Vestibulum sed finibus lectus.

















```

### Result

![Result](docs/result.png)
Looks cool, right?

[try it live!](https://mjml.io/try-it-live/templates/basic)

## How does MJML work?

With MJML, you can easily develop responsive email without the pain of coding. Its semantic syntax and standard components library speed up your development process, and MJML's open-source engine generates code in under a minute. This open-source engine generates high quality responsive HTML that adheres to best practices. It is an effective tool for creating emails that has a very intuitive interface.

The node `mjml-parse` is a NodeRED node that parses your MJML template and outputs the HTML.

![Example flow](docs/flow.png)

## Further reading

- [MJML documentation](https://documentation.mjml.io)
- [MJML templates](https://mjml.io/templates)
- [MJML live editor](https://mjml.io/try-it-live)
- [MJML vscode extension](https://marketplace.visualstudio.com/items?itemName=mjmlio.vscode-mjml)