Skip to content

Latest commit

 

History

History
33 lines (23 loc) · 1.09 KB

README.md

File metadata and controls

33 lines (23 loc) · 1.09 KB

GFM-style task list extension for league/commonmark

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

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