league/commonmark-extras

Useful extensions for customizing the league/commonmark Markdown parser

Installs: 12 894

Dependents: 6

Suggesters: 2

Stars: 21

Watchers: 4

Forks: 5

Open Issues: 4

Type:commonmark-extension

0.3.0 2019-04-11 04:39 UTC

README

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

league/commonmark-extras is a collection of useful extensions and utilities for the league/commonmark project.

Adding this extension to your project will automatically register these sub-extensions:

Extension Purpose
league/commonmark-ext-autolink Automatically creating links to URLs and email address (without needing the <...> syntax)
league/commonmark-ext-smartpunct Intelligently converts ASCII quotes, dashes, and ellipses to their Unicode equivalents

Install

Via Composer

$ composer require league/commonmark-extras

Usage

This can be added to any new Environment:

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.

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.