Skip to content

Commit 67a05d2

Browse files
committed
feature(docs): updated content
- Created new 'Community Contributions' section and moved several from 'Tooling' - Removed 'Passport' section and moved Mailjet into 'Community Contributions
1 parent 8b97136 commit 67a05d2

File tree

5 files changed

+56
-50
lines changed

5 files changed

+56
-50
lines changed

doc/community-contributions.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
## Community Contributions
2+
3+
The MJML ecosystem has a dedicated community that we count to help make it grow and provide it with even more awesome tools, always aiming to make development with MJML an efficient and fun process!
4+
5+
Getting involved is really easy. If you want to contribute, feel free to [open an issue](https://github.com/mjmlio/mjml/issues) or [submit a pull-request](https://github.com/mjmlio/mjml/pulls)!
6+
7+
Here are some tools that utilise MJML:
8+
9+
### Mailjet
10+
11+
If you would you rather use a friendly drag-and-drop interface, [Try Mailjet](https://www.mailjet.com/demo/), the email builder based on MJML!
12+
13+
[Mailjet](https://www.mailjet.com/demo/) offers an integrated MJML workspace designed for creating, previewing, and managing email templates. Its MJML editor supports syntax highlighting, live preview, and validation, helping you move quickly while keeping your markup in good shape.
14+
15+
The drag-and-drop editor in Mailjet is also built on MJML, so visually created templates share the same responsive structure as those coded by hand.
16+
17+
When your template is ready, you can export it in MJML or HTML, or send emails directly through Mailjet.
18+
19+
### Parcel
20+
21+
[Parcel](https://parcel.io) is the code editor built for email. This feature packed tool includes syntax highlighting, Emmet, inline documentation, autocomplete, live preview, screenshots, and full MJML, CSS, and HTML validation.
22+
23+
Use Focus Mode to keep the preview aligned with the code you're working on, or Inspect Element to easily find the code that produces specific elements in the preview.
24+
25+
Export MJML to HTML with a click.
26+
27+
### IntelliJ IDEA Plugin - MJML Support
28+
29+
[IntelliJ IDEA](https://www.jetbrains.com/idea/) is an IDE developed by JetBrains. The plugin provides you with a (near) realtime preview, auto complete, inline documentation and code analysis.
30+
31+
It is available on the [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/16418-mjml-support).
32+
33+
### Gradle Plugin - MJML Compilation
34+
35+
[Gradle](https://gradle.org/) is a build tool for a various set of languages and environments. The plugin provides an easy way to embed your MJML templates to your Java/Kotlin application in its resources in precompiled form (HTML).
36+
37+
It is available through the gradle plugin system [io.freefair.mjml.java](https://plugins.gradle.org/plugin/io.freefair.mjml.java) and documentation is available here [FreeFair User Guide](https://docs.freefair.io/gradle-plugins/current/reference/).
38+
39+
### Neos CMS
40+
41+
[Neos CMS](https://www.neos.io/) is a content management system that combines structured content with application. This package adds the helper for compiling MJML markup as well as some prototypes which allow you to use TailwindCSS like classes in your MJML markup.
42+
43+
It is available on [packagist](https://packagist.org/packages/garagist/mjml).
44+
45+
### Easy-email
46+
47+
[Easy-email](https://github.com/zalify/easy-email) drag-and-drop email editor based on MJML. Transform structured JSON data into HTML that’s compatible with major email clients.
48+
49+
### Email Love
50+
51+
The [Email Love Figma plugin](https://www.figma.com/community/plugin/1387891288648822744/email-love-html-email-builder) takes the headache out of the email development process by enabling you to export responsive, production-ready email HTML or MJML directly from Figma.

doc/config.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,5 +43,5 @@
4343
"mjml/doc/create.md",
4444
"mjml/doc/using_mjml_in_json.md",
4545
"mjml/doc/tooling.md",
46-
"mjml/doc/passport.md"
46+
"mjml/doc/community-contributions.md"
4747
]

doc/passport.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

doc/tooling.md

Lines changed: 0 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -19,45 +19,3 @@ It is available [on Github](https://github.com/mjmlio/mjml-syntax) and through t
1919
[Gulp](https://gulpjs.com/) is a tool designed to help you automate and enhance your workflow. Our plugin enables you to plug the MJML translation engine into your workflow, helping you to streamline your development workflow.
2020

2121
It is available here on [Github](https://github.com/mjmlio/gulp-mjml).
22-
23-
## Contribute to the MJML ecosystem
24-
25-
The MJML ecosystem has a dedicated community that we count to help make it grow and provide it with even more awesome tools, always aiming to make development with MJML an efficient and fun process!
26-
27-
Getting involved is really easy. If you want to contribute, feel free to [open an issue](https://github.com/mjmlio/mjml/issues) or [submit a pull-request](https://github.com/mjmlio/mjml/pulls)!
28-
29-
Here are some tools that utilise MJML:
30-
31-
### Parcel
32-
33-
[Parcel](https://parcel.io) is the code editor built for email. This feature packed tool includes syntax highlighting, Emmet, inline documentation, autocomplete, live preview, screenshots, and full MJML, CSS, and HTML validation.
34-
35-
Use Focus Mode to keep the preview aligned with the code you're working on, or Inspect Element to easily find the code that produces specific elements in the preview.
36-
37-
Export MJML to HTML with a click.
38-
39-
### IntelliJ IDEA Plugin - MJML Support
40-
41-
[IntelliJ IDEA](https://www.jetbrains.com/idea/) is an IDE developed by JetBrains. The plugin provides you with a (near) realtime preview, auto complete, inline documentation and code analysis.
42-
43-
It is available on the [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/16418-mjml-support).
44-
45-
### Gradle Plugin - MJML Compilation
46-
47-
[Gradle](https://gradle.org/) is a build tool for a various set of languages and environments. The plugin provides an easy way to embed your MJML templates to your Java/Kotlin application in its resources in precompiled form (HTML).
48-
49-
It is available through the gradle plugin system [io.freefair.mjml.java](https://plugins.gradle.org/plugin/io.freefair.mjml.java) and documentation is available here [FreeFair User Guide](https://docs.freefair.io/gradle-plugins/current/reference/).
50-
51-
### Neos CMS
52-
53-
[Neos CMS](https://www.neos.io/) is a content management system that combines structured content with application. This package adds the helper for compiling MJML markup as well as some prototypes which allow you to use TailwindCSS like classes in your MJML markup.
54-
55-
It is available on [packagist](https://packagist.org/packages/garagist/mjml).
56-
57-
### Easy-email
58-
59-
[Easy-email](https://github.com/zalify/easy-email) drag-and-drop email editor based on MJML. Transform structured JSON data into HTML that’s compatible with major email clients.
60-
61-
### Email Love
62-
63-
The [Email Love Figma plugin](https://www.figma.com/community/plugin/1387891288648822744/email-love-html-email-builder) takes the headache out of the email development process by enabling you to export responsive, production-ready email HTML or MJML directly from Figma.

packages/mjml-accordion/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
### mj-accordion
22

3-
<figure>
4-
<img src="https://static.mailjet.com/mjml-website/documentation/accordion-example.gif" alt="accordion" />
5-
</figure>
6-
73
An interactive MJML component that stacks content in tabs, so the information is collapsed and only the titles are visible.
84

95
Readers can interact by clicking on the tabs to reveal the content, providing a better experience for mobile users by reducing the amount of scrolling.
106

7+
<figure>
8+
<img src="https://static.mailjet.com/mjml-website/documentation/accordion-example.gif" alt="accordion" />
9+
</figure>
10+
1111
<div class="alert alert-note" role="alert">
1212
<p>Note</p>
1313
<p><code>mj-accordion-text</code> and <code>mj-accordion-title</code> are "ending tags", which means that they can contain HTML code but they cannot contain other MJML components.</p>

0 commit comments

Comments
 (0)