spatie / mjml-sidecar
Compile MJML to HTML using Sidecar
Installs: 2 861
Dependents: 0
Suggesters: 1
Security: 0
Stars: 7
Watchers: 4
Forks: 0
Open Issues: 0
Requires
- php: ^8.1
- hammerstone/sidecar: ^0.4.1
- illuminate/contracts: ^10.0
- spatie/laravel-package-tools: ^1.14.0
- spatie/mjml-php: ^1.0
Requires (Dev)
- laravel/pint: ^1.0
- nunomaduro/collision: ^7.8
- nunomaduro/larastan: ^2.0.1
- orchestra/testbench: ^8.8
- pestphp/pest: ^2.0
- pestphp/pest-plugin-arch: ^2.0
- pestphp/pest-plugin-laravel: ^2.0
- phpstan/extension-installer: ^1.1
- phpstan/phpstan-deprecation-rules: ^1.0
- phpstan/phpstan-phpunit: ^1.0
- spatie/laravel-ray: ^1.26
README
This is a companion package to mjml-php that runs compilation through Sidecar instead.
Support us
We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.
Installation
You can install the package via composer:
composer require spatie/mjml-sidecar
Register the MjmlFunction
in your sidecar.php
config file.
/* * All of your function classes that you'd like to deploy go here. */ 'functions' => [ \Spatie\MjmlSidecar\MjmlFunction::class, ],
Deploy the Lambda function by running:
php artisan sidecar:deploy --activate
See the Sidecar documentation for details.
Usage
For usage, check the mjml-php documentation.
All the methods are available, just make sure to add ->sidecar()
, for example:
Mjml::new()->sidecar()->toHtml($mjml);
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
License
The MIT License (MIT). Please see License File for more information.