{"id":19324888,"url":"https://github.com/spatie/mjml-sidecar","last_synced_at":"2025-04-22T20:30:43.147Z","repository":{"id":190212707,"uuid":"682169316","full_name":"spatie/mjml-sidecar","owner":"spatie","description":"Compile MJML to HTML using Sidecar","archived":false,"fork":false,"pushed_at":"2025-03-27T08:52:14.000Z","size":2881,"stargazers_count":7,"open_issues_count":1,"forks_count":3,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-27T09:38:30.392Z","etag":null,"topics":["mails","mjml","sidecar"],"latest_commit_sha":null,"homepage":"https://freek.dev/2549-convert-mjml-to-html-using-php","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/spatie.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-08-23T15:33:46.000Z","updated_at":"2025-03-27T08:31:40.000Z","dependencies_parsed_at":null,"dependency_job_id":"e5600ce3-f423-46b5-9f8a-16d55265df41","html_url":"https://github.com/spatie/mjml-sidecar","commit_stats":null,"previous_names":["spatie/mjml-sidecar"],"tags_count":3,"template":false,"template_full_name":"spatie/package-skeleton-laravel","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spatie%2Fmjml-sidecar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spatie%2Fmjml-sidecar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spatie%2Fmjml-sidecar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spatie%2Fmjml-sidecar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/spatie","download_url":"https://codeload.github.com/spatie/mjml-sidecar/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250318572,"owners_count":21410957,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["mails","mjml","sidecar"],"created_at":"2024-11-10T02:07:20.654Z","updated_at":"2025-04-22T20:30:41.772Z","avatar_url":"https://github.com/spatie.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Compile MJML to HTML using Sidecar\n\n[![Latest Version on Packagist](https://img.shields.io/packagist/v/spatie/mjml-sidecar.svg?style=flat-square)](https://packagist.org/packages/spatie/mjml-sidecar)\n[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/spatie/mjml-sidecar/run-tests.yml?branch=main\u0026label=tests\u0026style=flat-square)](https://github.com/spatie/mjml-sidecar/actions?query=workflow%3Arun-tests+branch%3Amain)\n[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/spatie/mjml-sidecar/fix-php-code-style-issues.yml?branch=main\u0026label=code%20style\u0026style=flat-square)](https://github.com/spatie/mjml-sidecar/actions?query=workflow%3A\"Fix+PHP+code+style+issues\"+branch%3Amain)\n[![Total Downloads](https://img.shields.io/packagist/dt/spatie/mjml-sidecar.svg?style=flat-square)](https://packagist.org/packages/spatie/mjml-sidecar)\n\nThis is a companion package to [mjml-php](https://github.com/spatie/mjml-php) that runs compilation through [Sidecar](https://hammerstone.dev/sidecar) instead.\n\n## Support us\n\n[\u003cimg src=\"https://github-ads.s3.eu-central-1.amazonaws.com/mjml-sidecar.jpg?t=1\" width=\"419px\" /\u003e](https://spatie.be/github-ad-click/mjml-sidecar)\n\nWe invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).\n\nWe 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](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).\n\n## Installation\n\nYou can install the package via composer:\n\n```bash\ncomposer require spatie/mjml-sidecar\n```\n\nRegister the `MjmlFunction` in your `sidecar.php` config file.\n\n```php\n/*\n * All of your function classes that you'd like to deploy go here.\n */\n'functions' =\u003e [\n    \\Spatie\\MjmlSidecar\\MjmlFunction::class,\n],\n```\n\nDeploy the Lambda function by running:\n\n```shell\nphp artisan sidecar:deploy --activate\n```\n\nSee the [Sidecar documentation](https://hammerstone.dev/sidecar/docs/main/functions/deploying) for details.\n\n## Usage\n\nFor usage, check the [mjml-php](https://github.com/spatie/mjml-php) documentation.\n\nAll the methods are available, just make sure to add `-\u003esidecar()`, for example:\n\n```php\nMjml::new()-\u003esidecar()-\u003etoHtml($mjml);\n```\n\n## Testing\n\n```bash\ncomposer test\n```\n\n## Changelog\n\nPlease see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.\n\n## Contributing\n\nPlease see [CONTRIBUTING](CONTRIBUTING.md) for details.\n\n## Security Vulnerabilities\n\nPlease review [our security policy](../../security/policy) on how to report security vulnerabilities.\n\n## Credits\n\n- [Rias Van der Veken](https://github.com/spatie)\n- [All Contributors](../../contributors)\n\n## License\n\nThe MIT License (MIT). Please see [License File](LICENSE.md) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspatie%2Fmjml-sidecar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspatie%2Fmjml-sidecar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspatie%2Fmjml-sidecar/lists"}