league/commonmark-extras

Useful extensions for customizing the league/commonmark parser

league/commonmark-extras

![Software License][ico-license] ![Coverage Status][ico-scrutinizer] ![Total Downloads][ico-downloads], _(*1)

DEPRECATED

This extension has been deprecated. All of its functionality now exists in league/commonmark 1.3+. You can either register the various extensions individually or use the GithubFlavoredMarkdownExtension to get full GFM functionality, so you should upgrade to that version of league/commonmark and use that instead of this one., _(*2)

Overview

league/commonmark-extras is a collection of useful GFM extensions and utilities for the league/commonmark project., _(*3)

Adding this extension to your project will automatically register these sub-extensions:, _(*4)

Install

Via Composer, _(*5)

``` bash $ composer require league/commonmark-extras, <sub>(*6)</sub>

## Usage

This can be added to any new `Environment`:

``` php
use League\CommonMark\CommonMarkConverter;
use League\CommonMark\Environment;
use League\CommonMark\Extras\CommonMarkExtrasExtension;

// Obtain a pre-configured Environment with all the CommonMark parsers/renderers ready-to-go
$environment = Environment::createCommonMarkEnvironment();

// REGISTER THIS EXTENSION HERE
$environment->addExtension(new CommonMarkExtrasExtension());

// Define your configuration:
$config = [];

// Now that the `Environment` is configured we can create the converter engine:
$converter = new CommonMarkConverter($config, $environment);

// Go forth and convert you some Markdown!
echo $converter->convertToHtml('# Hello World!');

Change log

Please see CHANGELOG for more information what has changed recently., <sub>(*7)</sub>

Testing

bash $ composer test, <sub>(*8)</sub>

Security

If you discover any security related issues, please email colinodell@gmail.com instead of using the issue tracker., <sub>(*9)</sub>

Credits

• Colin O'Dell
• All Contributors

License

This library is licensed under the BSD-3 license. See the LICENSE file for more information., <sub>(*10)</sub>