⏫ Upgrading
Information on how to upgrade to newer versions of this library can be found at https://commonmark.thephpleague.com/releases.
💻 GitHub-Flavored Markdown
The GithubFlavoredMarkdownConverter shown earlier is a drop-in replacement for the CommonMarkConverter which adds additional features found in the GFM spec:
- Autolinks
- Disallowed raw HTML
- Strikethrough
- Tables
- Task Lists
See the Extensions documentation for more details on how to include only certain GFM features if you don’t want them all.
🗃️ Related Packages
Integrations
- CakePHP 3
- Drupal
- Laravel 4+
- Sculpin
- Symfony 2 & 3
- Symfony 4
- Twig Markdown extension
- Twig filter and tag
- Laravel CommonMark Blog
Included Extensions
See our extension documentation for a full list of extensions bundled with this library.
Others
Check out the other cool things people are doing with league/commonmark: https://packagist.org/packages/league/commonmark/dependents
🏷️ Versioning
SemVer is followed closely. Minor and patch 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, spec changes, etc.) As a result, you might get slightly different HTML, but any custom code built onto this library should still function correctly.
Any classes or methods marked @internal are not intended for use outside of this library and are subject to breaking changes at any time, so please avoid using them.
🚀 Performance Benchmarks
You can compare the performance of league/commonmark to other popular parsers by running the included benchmark tool:
$ ./tests/benchmark/benchmark.php
👥 Credits & Acknowledgements
- [Colin O’Dell][@colinodell]
- [John MacFarlane][@jgm]
- [All Contributors]
This code is partially based on the [CommonMark JS reference implementation][commonmark.js] which is written, maintained and copyrighted by [John MacFarlane]. This project simply wouldn’t exist without his work.
🏛️ Governance
This project is primarily maintained by [Colin O’Dell][@colinodell]. Members of the [PHP League] Leadership Team may occasionally assist with some of these duties.