league / commonmark-ext-inlines-only
Extension for league/commonmark which only renders inline text
Fund package maintenance!
colinodell
Patreon
Installs: 26 613
Dependents: 1
Suggesters: 0
Security: 0
Stars: 1
Watchers: 2
Forks: 1
Open Issues: 0
Type:commonmark-extension
Requires
- php: ^7.1
- league/commonmark: ^1.3
Requires (Dev)
- phpunit/phpunit: ^7.5
This package is auto-updated.
Last update: 2020-04-04 14:54:32 UTC
README
DEPRECATED
This extension has been deprecated. All of its functionality now exists in league/commonmark
1.3+ under the League\CommonMark\Extension\InlinesOnly
namespace, so you should upgrade to that version and use that bundled extension instead of this one.
Overview
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.