league/commonmark

PHP Markdown parser based on the CommonMark spec


README

Latest Version Total Downloads Software License Build Status Coverage Status Quality Score SensioLabs Insight CII Best Practices

league/commonmark is a PHP-based Markdown parser created by Colin O'Dell which supports the full CommonMark spec. It is based on the CommonMark JS reference implementation by John MacFarlane (@jgm).

Goals

  • Fully support the CommonMark spec (100% compliance)
  • Match the C and JavaScript implementations of CommonMark to make a logical and similar API
  • Continuously improve performance without sacrificing quality or compliance
  • Provide an extensible parser/renderer which users may customize as needed

Installation

This project can be installed via Composer:

$ composer require league/commonmark

Note: See Versioning for important information on which version constraints you should use.

Basic Usage

The CommonMarkConverter class provides a simple wrapper for converting CommonMark to HTML:

use League\CommonMark\CommonMarkConverter;

$converter = new CommonMarkConverter();
echo $converter->convertToHtml('# Hello World!');

// <h1>Hello World!</h1>

⚠️Security warning: If you will be parsing untrusted input from users, please consider setting the html_input and allow_unsafe_links options. See https://commonmark.thephpleague.com/security/ for more details.

If you also do choose to allow raw HTML input from untrusted users, considering using a library (like HTML Purifier) to provide additional HTML filtering.

Documentation

Full documentation on advanced usage, configuration, and customization can be found at commonmark.thephpleague.com.

Upgrading

Information on how to upgrade to newer versions of this library can be found at https://commonmark.thephpleague.com/releases.

Related Packages

Integrations

League Extensions

The PHP League offers useful extensions that add extra syntax and features:

You can add them to your project or use them as examples to develop your own custom features.

Community Extensions

Custom parsers/renderers can be bundled into extensions which extend CommonMark. Here are some that you may find interesting:

If you build your own, feel free to submit a PR to add it to this list!

Others

Check out the other cool things people are doing with league/commonmark: https://packagist.org/packages/league/commonmark/dependents

Compatibility with CommonMark

This project aims to fully support the entire CommonMark spec. Other flavors of Markdown may work but are not supported. Any/all changes made to the spec or JS reference implementation should eventually find their way back into this codebase.

league/commonmark 0.19.0 and higher supports version 0.29 of the CommonMark spec.

(This package is not part of CommonMark, but rather a compatible derivative.)

Testing

$ composer test

This will also test league/commonmark against the latest supported spec.

Performance Benchmarks

You can compare the performance of league/commonmark to other popular parsers by running the included benchmark tool:

$ ./tests/benchmark/benchmark.php

Versioning

SemVer will be followed closely. 0.x.0 versions will introduce breaking changes to the codebase, so be careful which version constraints you use. It's highly recommended that you use Composer's caret operator to ensure compatibility; for example: ^0.18. This is equivalent to >=0.18.0 <0.19.0.

0.x.y releases should not introduce breaking changes to the codebase; however, they might change the resulting AST or HTML output of parsed Markdown (due to bug fixes, minor spec changes, etc.) As a result, you might get slightly different HTML, but any custom code built onto this library will still function correctly.

If you're only using the CommonMarkConverter class or ConverterInterface to convert Markdown (no other class references, custom parsers, etc.), then it should be safe to use a broader constraint like ~0.18, >0.18, etc. I personally promise to never break this specific class in any future 0.x release.

Stability

While this package does work well, the underlying code should not be considered "stable" yet. The original spec and JS parser may undergo changes in the near future which will result in corresponding changes to this code. Any methods tagged with @api are not expected to change, but other methods/classes might.

Major release 1.0.0 will be reserved for when either the CommonMark spec or this project are considered stable (see outstanding CommonMark spec issues). 0.x.y will be used until that happens.

Contributing

If you encounter a bug in the spec, please report it to the CommonMark project. Any resulting fix will eventually be implemented in this project as well.

For now, I'd like to maintain similar logic as the JS reference implementation until everything is stable. I'll gladly accept any contributions which:

  • Mirror fixes made to the reference implementation
  • Optimize existing methods or regular expressions
  • Fix issues with adhering to the spec examples

Major refactoring should be avoided for now so that we can easily follow updates made to the reference implementation. This restriction will likely be lifted once the CommonMark specs and implementations are considered stable.

Please see CONTRIBUTING for additional details.

Security

If you discover any security related issues, please email your report privately to colinodell@gmail.com instead of using the issue tracker.

Credits & Acknowledgements

This code is a port of the CommonMark JS reference implementation which is written, maintained and copyrighted by John MacFarlane. This project simply wouldn't exist without his work.

Also a huge thank you to JetBrains for supporting the development of this project with complimentary PhpStorm licenses.

License

league/commonmark is licensed under the BSD-3 license. See the LICENSE file for more details.

Governance

This project is primarily maintained by Colin O'Dell. Members of the PHP League Leadership Team may occasionally assist with some of these duties.