lorenzo/pinky

A Foundation for Emails (Inky) template transpiler

Maintainers

Details

github.com/lorenzo/pinky

Source

Issues

Installs: 2 772 762

Dependents: 7

Suggesters: 1

Security: 0

Stars: 209

Watchers: 5

Forks: 13

Open Issues: 3

1.0.6 2022-03-17 12:11 UTC

This package is auto-updated.

Last update: 2022-05-17 12:39:31 UTC


README

A PHP Transpiler for (Inky), the templating language made for the Foundation for Email framework.

Installation

You can install this bundle using composer

composer require lorenzo/pinky

Usage and Examples

Basic Usage

<?php
use Pinky;

$transpiled = Pinky\transformFile('path/to/file.html');

// $transpiled is an instance of DOMDocument
echo $transpiled->saveHTML();

You can transpile strings directly:

<?php
use Pinky;

$transpiled = Pinky\transformString('<row>Contents</row>');
echo $transpiled->saveHTML();

And you can also transpile many files or strings in batch:

<?php
use Pinky;

$files = [$path1, $path2, $path3];

$transpiled = Pinky\transformManyFiles($files);
foreach ($transpiled as $result) {
    echo $result->saveHTML();
}

License

See the LICENSE file for license info (it's the MIT license).