This extension adds strikethrough Markdown support for the league/commonmark PHP Markdown parsing engine, which itself is based on the CommonMark spec.
It allows users to use ~~
in order to indicate text that should be rendered within <del>
tags.
This project can be installed via Composer:
$ composer require league/commonmark-ext-strikethrough
Extensions can be added to any new Environment
:
use League\CommonMark\CommonMarkConverter;
use League\CommonMark\Environment;
use League\CommonMark\Ext\Strikethrough\StrikethroughExtension;
// Obtain a pre-configured Environment with all the CommonMark parsers/renderers ready-to-go
$environment = Environment::createCommonMarkEnvironment();
// Add this extension
$environment->addExtension(new StrikethroughExtension());
// Instantiate the converter engine and start converting some Markdown!
$converter = new CommonMarkConverter($config, $environment);
echo $converter->convertToHtml('This extension is ~~good~~ great!');
Please see CHANGELOG for more information what has changed recently.
$ composer test
If you discover any security related issues, please email colinodell@gmail.com instead of using the issue tracker.
This library is licensed under the MIT license. See the LICENSE
file for more information.