Skip to content
GFM-style task lists for league/commonmark
PHP
Branch: master
Clone or download
Latest commit b3c0c50 Oct 11, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update FUNDING.yml Oct 11, 2019
src Optimize a regular expression Jul 11, 2019
tests
.editorconfig Initial commit May 12, 2019
.gitattributes Initial commit May 12, 2019
.gitignore Initial commit May 12, 2019
.scrutinizer.yml Initial commit May 12, 2019
.styleci.yml Initial commit May 12, 2019
.travis.yml Initial commit May 12, 2019
CHANGELOG.md Release v1.0.1 Jul 11, 2019
CONDUCT.md Initial commit May 12, 2019
CONTRIBUTING.md Initial commit May 12, 2019
LICENSE Initial commit May 12, 2019
README.md Initial commit May 12, 2019
composer.json Prepare to release v1.0.0 Jun 29, 2019
phpunit.xml.dist Initial commit May 12, 2019

README.md

GFM-style task list extension for league/commonmark

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

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.

You can’t perform that action at this time.