davidgorges/editorjs-twig-renderer

Render EditorJS output via Twig

dev-main 2022-01-06 12:45 UTC

This package is auto-updated.

Last update: 2024-11-30 02:29:20 UTC


README

Render EditorJS output via Twig

Work in Progress

This library is currently in work in progress and not ready for use.

Installation

Install this package as a dependency using Composer.

composer require davidgorges/editorjs-twig-renderer

Usage

use EditorJs\Parser;


$json = '{
    "blocks": [
        {
            "type": "header",
            "data": {
                "text": "Hello World",
                "level": 1
            }
        }
    ]
}';

$twigRenderer = new TwigRenderer('/path-to/editorjs.html.twig');
$parser = new Parser($twigRenderer);
$html = $parser->parse($json);

echo $html;
// Output: <h1>Hello World</h1>

Customize

You can provider your own Twig template to render the output.

{% block header %}
<h{{ level }}>{{ text }}</h{{ level }}>
{% endblock %}

See tests/data/editorjs.html.twig for more examples of how to customize the output.

Contributing

Contributions are welcome! To contribute, please familiarize yourself with CONTRIBUTING.md.

Copyright and License

The davidgorges/editorjs-twig-renderer library is copyright © David Gorges and licensed for use under the terms of the MIT License (MIT). Please see LICENSE for more information.