This extension has been deprecated. All of its functionality now exists in league/commonmark
1.3+ under the League\CommonMark\Extension\TaskList
namespace, so you should upgrade to that version and use that bundled extension instead of this one.
This extension adds GFM-style task list items to the league/commonmark
Markdown parser for PHP.
Via Composer
$ composer require league/commonmark-ext-task-list
Configure your Environment
as usual and simply add the TaskListExtension
provided by this package:
use League\CommonMark\CommonMarkConverter;
use League\CommonMark\Environment;
use League\CommonMark\Ext\TaskList\TaskListExtension;
// Obtain a pre-configured Environment with all the CommonMark parsers/renderers ready-to-go
$environment = Environment::createCommonMarkEnvironment();
// Add this extension
$environment->addExtension(new TaskListExtension());
// Instantiate the converter engine and start converting some Markdown!
$converter = new CommonMarkConverter([], $environment);
$markdown = <<<EOT
- [x] Install this extension
- [ ] ???
- [ ] Profit!
EOT;
echo $converter->convertToHtml($markdown);
Please see CHANGELOG for more information what has changed recently.
$ composer test
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
This library is licensed under the BSD-3 license. See the License File for more information.