timo-reymann / intellij-mjml-support

MJML support for the IntelliJ Platform.
https://timo-reymann.github.io/intellij-mjml-support/
Other
26 stars 11 forks source link
idea-plugin intellij intellij-plugin

intellij-mjml-support

CircleCI Version Downloads Rating Renovate Quality Gate Status Reliability Rating FOSSA Status


MJML support for the IntelliJ Platform.

Features

Requirements

Installation

  1. Press (Ctrl+Alt+S/⌘/) to open the IDE settings and select Plugins.
  2. Search for MJML Support in the Marketplace and click Install.

You live on the edge?

There is also the channel snapshot (https://plugins.jetbrains.com/plugins/snapshot/list) available, for more details about set up please see JetBrains Marketplace Docs

The versioning used there is not based on semantic versioning, but rather: YYYY.MM.DD-BUILDNUM and is on

Usage

Motivation

I wanted MJML Support for my beloved JetBrains IDEs.

Contributing

I love your input! I want to make contributing to this project as easy and transparent as possible, whether it's:

To get started please read the Contribution Guidelines.

Documentation

Extending plugin functionality with additional plugins

If you want to support custom functionality or resolving maybe specific to the needs your company, there are some entrypoints available.

Custom mjml resolution

You want to add custom mjml tags or custom resolving to match your needs?

Simply use the extension point de.timo_reymann.intellij-mjml-support.tagInformationProvider:

<extensions defaultExtensionNs="de.timo_reymann.intellij-mjml-support">
    <tagInformationProvider implementation="my.company.OurCustomTaginformationProvider"/>
</extensions>

Custom rendering

Notes about implementation

Architecture Decision Records

For architecture decision records please take a look at docs/adr, this will give you an idea why implementations are as they are.

Development

Requirements

Test

# To run unit tests
./gradlew test

# To run plugin verifier to check compability
./gradlew runPluginVerifier

Build

./gradlew buildPlugin