daysofwonder/phpleague-commonmark-implicit-figures

Render images occurring by itself in a paragraph as `<figure><img ...></figure>`, similar to pandoc's implicit figures

2.0.0 2022-11-14 14:47 UTC

Requires

• php: ^7.4
• league/commonmark: ^2.0

Requires (Dev)

• phpunit/phpunit: ^5.7

MIT

• Florent Ruard-Dumaine

• parser
• markdown
• commonmark
• figure

README

Render images occurring by itself in a paragraph as <figure><img ...></figure>, clearly inspired from markdown-it-implicit-figures and similar to pandoc's implicit figures.

Installation

This project can be installed via Composer:

composer require daysofwonder/phpleague-commonmark-implicit-figures

Usage

use League\CommonMark\Converter;
use League\CommonMark\DocParser;
use League\CommonMark\Environment;
use League\CommonMark\HtmlRenderer;
use DoW\CommonMark\ImplicitFigures\Extension;

$environment = Environment::createCommonMarkEnvironment();
$environment->addExtension(new \DoW\CommonMark\ImplicitFigures\Extension());

$converter = new Converter(new DocParser($environment), new HtmlRenderer($environment));

echo $converter->convertToHtml('![title](fig.png)');

Syntax

Example input:

text with ![](img.png)

![title](fig.png)

works with links too:

[![](fig.png)](page.html)

Output:

<p>text with <img src="img.png" alt=""></p>
<figure><img src="fig.png" alt=""></figure>
<p>works with links too:</p>
<figure><a href="page.html"><img src="fig.png" alt=""></a></figure>