league/commonmark-ext-inlines-only

Extension for league/commonmark which only renders inline text

v1.0.0 2019-06-29 11:38 UTC

README

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

This extension configures the league/commonmark Markdown parser for PHP to only render inline elements - no paragraph tags, headers, code blocks, etc.

Install

Via Composer

$ composer require league/commonmark-ext-inlines-only

Usage

Although you normally add extra extensions to the default core one, we're not going to do that here, because this is essentially a slimmed-down version of the core extension:

use League\CommonMark\CommonMarkConverter;
use League\CommonMark\Environment;
use League\CommonMark\Ext\InlinesOnly\InlinesOnlyExtension;

// Create a new, empty environment
$environment = new Environment();

// Add this extension
$environment->addExtension(new InlinesOnlyExtension());

// Instantiate the converter engine and start converting some Markdown!
$converter = new CommonMarkConverter($config, $environment);
echo $converter->convertToHtml('**Hello World!**');

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.