thephpleague/commonmark-extras

Name: commonmark-extras

Owner: The League of Extraordinary Packages

Description: Useful extensions for the league/commonmark parser

Created: 2016-01-13 18:07:59.0

Updated: 2018-05-03 12:45:53.0

Pushed: 2018-01-19 02:17:18.0

Homepage: null

Size: 24

Language: PHP

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

league/commonmark-extras

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.

Install

Via Composer

mposer require league/commonmark-extras
Usage

Extensions can be added to any new Environment:

League\CommonMark\CommonMarkConverter;
League\CommonMark\Environment;
League\CommonMark\Extras\SmartPunct\SmartPunctExtension;

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

DD YOUR OWN EXTENSIONS HERE. For example:
ironment->addExtension(new SmartPunctExtension());

efine your configuration:
fig = [];

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

o forth and convert you some Markdown!
 $converter->convertToHtml('# Hello World!');
Change log

Please see CHANGELOG for more information what has changed recently.

Testing
mposer test
Contributing

New features and extensions are welcome! Please see CONTRIBUTING and CONDUCT for details.

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.


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.