league/commonmark-ext-task-list

This package is abandoned and no longer maintained. The author suggests using the league/commonmark package instead.

Extension for league/commonmark which supports GFM-style task lists

Fund package maintenance!
colinodell
Patreon

Installs: 18 825

Dependents: 1

Suggesters: 0

Security: 0

Stars: 3

Watchers: 3

Forks: 0

Open Issues: 0

Type:commonmark-extension

v1.1.0 2020-04-04 15:49 UTC

This package is auto-updated.

Last update: 2020-04-04 15:50:10 UTC


README

Latest Version on Packagist Software License Build Status Coverage Status Quality Score Total Downloads

DEPRECATED

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.

Overview

This extension adds GFM-style task list items to the league/commonmark Markdown parser for PHP.

Install

Via Composer

$ composer require league/commonmark-ext-task-list

Usage

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);

Changelog

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Security

If you discover any security related issues, please email colinodell@gmail.com instead of using the issue tracker.

Credits

License

This library is licensed under the BSD-3 license. See the License File for more information.