https://github.com/shyam-chen/mjml-starter

:e-mail: A boilerplate for building responsive HTML emails with MJML, PostHTML, and YAML in Nunjucks on Gulp.
https://github.com/shyam-chen/mjml-starter

email gulp mjml nunjucks posthtml yaml

Last synced: 4 months ago
JSON representation

:e-mail: A boilerplate for building responsive HTML emails with MJML, PostHTML, and YAML in Nunjucks on Gulp.

• Host: GitHub
• URL: https://github.com/shyam-chen/mjml-starter
• Owner: Shyam-Chen
• Created: 2016-01-11T11:17:40.000Z (about 9 years ago)
• Default Branch: main
• Last Pushed: 2024-07-31T03:18:24.000Z (7 months ago)
• Last Synced: 2024-07-31T05:33:45.644Z (7 months ago)
• Topics: email, gulp, mjml, nunjucks, posthtml, yaml
• Language: JavaScript
• Homepage:
• Size: 346 KB
• Stars: 3
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Email Starter

:e-mail: A boilerplate for building responsive HTML emails.

## Prerequisites

- [Node.js](https://nodejs.org/)

- [Pnpm](https://pnpm.js.org/)

## Usage

1. Clone this repository and install its dependencies

```sh

$ git clone https://github.com/Shyam-Chen/Email-Starter email-template-builder

$ cd email-template-builder

$ pnpm install

```

2. Start a development server

Transpiles: `posthtml` -> Data (`yaml`) + `nunjucks` -> `mjml` -> `html`

```sh

$ pnpm serve

```

3. Build templates

Transpiles: `posthtml` -> `mjml` -> `html` (`nunjucks` ready)

```sh

$ pnpm build

```

4. Move templates

```sh

$ pnpm move --to=../path/to/src/templates

```

## Features

- [Gulp](https://github.com/gulpjs/gulp) - Build Tool

- [MJML](https://github.com/mjmlio/mjml) - Email Framework

- [PostHTML](https://github.com/posthtml/posthtml) - HTML Transformer

- [Nunjucks](https://github.com/mozilla/nunjucks) - Templating Engine

- [YAML](https://github.com/nodeca/js-yaml) - Mock Data