MJML: 实现响应式邮件的框架
jopen
9年前
| Introduction | Installation | Usage | Contribute |
Introduction
MJML是一种标记语言,设计用于轻松实现一个响应式邮件。它的语义语法使得它容易和简单,而其丰富的标准组件库可以减少你开发时间,并减轻您的邮件代码库。MJML是一个开源的引擎能够将MJML转换成响应式布局的HTML.
Installation
npm install -g mjml
Show me the code!
Command line
Compile the file and output the result in
a.html
$> mjml -r input.mjml
Redirect the result to a file
$> mjml -r input.mjml -o output.html
Watch a file and compile every time the file changes
$> mjml -w input.mjml -o output.html
Inside NodeJs
import mjml from 'mjml' /* Compile an mjml string */ const htmlOutput = mjml.mjml2html(`<mj-body> <mj-section> <mj-column> <mj-text> Hello World! </mj-text> </mj-column> </mj-section> </mj-body> `) /* Print the responsive HTML generated */ console.log(htmlOutput);
Create your component
Issue the following in your terminal
$> mjml --init-component <name of your component> # If your component cannot contain anything else than text: $> mjml --init-component <name of you component> -e # It means nothing inside it will be parsed by the mjml engine.
It will create a basic component template in a .js
file. Follow the instructions provided in the file and read more about custom components in the documentation
Try it live
Get your hands dirty by trying the MJML online editor! Write awesome code on the left side and preview your email on the right. You can also get the rendered HTML directly from the online editor.
Contributors
Maxime | Robin | Loeck | Guillaume | Meriadec | Arnaud | HTeuMeuLeu |
Contribute
- Fork the repository
- Code an awesome feature (we are confident about that)
- Make your pull request
- Add your github profile here