diff options
Diffstat (limited to 'vendor/league/commonmark/README.md')
| -rw-r--r-- | vendor/league/commonmark/README.md | 23 |
1 files changed, 17 insertions, 6 deletions
diff --git a/vendor/league/commonmark/README.md b/vendor/league/commonmark/README.md index d4c89fccd9..ed2a68c7cb 100644 --- a/vendor/league/commonmark/README.md +++ b/vendor/league/commonmark/README.md @@ -8,9 +8,10 @@ [](https://travis-ci.org/thephpleague/commonmark) [](https://scrutinizer-ci.com/g/thephpleague/commonmark/code-structure) [](https://scrutinizer-ci.com/g/thephpleague/commonmark) +[](https://insight.sensiolabs.com/projects/9bf971c0-458f-4a19-9898-127728dbd65d) [](https://bestpractices.coreinfrastructure.org/projects/126) -**league/commonmark** is a Markdown parser for PHP which supports the full [CommonMark] spec. It is based on the [CommonMark JS reference implementation][commonmark.js] by [John MacFarlane] \([@jgm]\). +**league/commonmark** is a PHP-based Markdown parser created by [Colin O'Dell][@colinodell] which supports the full [CommonMark] spec. It is based on the [CommonMark JS reference implementation][commonmark.js] by [John MacFarlane] \([@jgm]\). ## Goals @@ -114,6 +115,7 @@ Custom parsers/renderers can be bundled into extensions which extend CommonMark. - [CommonMark Table Extension](https://github.com/webuni/commonmark-table-extension) - Adds the ability to create tables in CommonMark documents. - [CommonMark Attributes Extension](https://github.com/webuni/commonmark-attributes-extension) - Adds a syntax to define attributes on the various HTML elements. - [Alt Three Emoji](https://github.com/AltThree/Emoji) An emoji parser for CommonMark. + - [uafrica/commonmark-ext](https://github.com/uafrica/commonmark-ext) - Adds strikethrough support. If you build your own, feel free to submit a PR to add it to this list! @@ -136,8 +138,12 @@ The following table shows which versions of league/commonmark are compatible wit </thead> <tbody> <tr> - <td><strong>0.15.3</strong><br>0.15.2</td> - <td><strong><a href="http://spec.commonmark.org/0.27/">0.27</a></strong></td> + <td><strong>0.16.0</strong><br>0.15.7<br>0.15.6<br>0.15.5</td> + <td><strong><a href="http://spec.commonmark.org/0.28/">0.28</a></strong></td> + </tr> + <tr> + <td>0.15.4<br>0.15.3<br>0.15.2</td> + <td><a href="http://spec.commonmark.org/0.27/">0.27</a></td> </tr> <tr> <td>0.15.1<br>0.15.0</td> @@ -214,11 +220,11 @@ $ ./tests/benchmark/benchmark.php ## Versioning -[SemVer](http://semver.org/) 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](https://getcomposer.org/doc/articles/versions.md#caret) to ensure compatibility**; for example: `^0.15`. This is equivalent to `>=0.15.0 <0.16.0`. +[SemVer](http://semver.org/) 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](https://getcomposer.org/doc/articles/versions.md#caret) to ensure compatibility**; for example: `^0.16`. This is equivalent to `>=0.16.0 <0.17.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 to convert Markdown (no other class references, custom parsers, etc.), then it should be safe to use a broader constraint like `~0.15`, `>0.15`, etc. I personally promise to never break this specific class in any future 0.x release. +If you're only using the `CommonMarkConverter` class to convert Markdown (no other class references, custom parsers, etc.), then it should be safe to use a broader constraint like `~0.16`, `>0.16`, etc. I personally promise to never break this specific class in any future 0.x release. ## Stability @@ -258,6 +264,10 @@ Also a huge thank you to [JetBrains](https://www.jetbrains.com/) for supporting **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][@colinodell]. Members of the [PHP League][php-league] Leadership Team may occassionally assist with some of these duties. + [CommonMark]: http://commonmark.org/ [CommonMark spec]: http://spec.commonmark.org/ [commonmark.js]: https://github.com/jgm/commonmark.js @@ -267,7 +277,8 @@ Also a huge thank you to [JetBrains](https://www.jetbrains.com/) for supporting [docs-example-twitter]: https://commonmark.thephpleague.com/customization/inline-parsing#example-1---twitter-handles [docs-example-smilies]: https://commonmark.thephpleague.com/customization/inline-parsing#example-2---emoticons [All Contributors]: https://github.com/thephpleague/commonmark/contributors -[@colinodell]: https://github.com/colinodell +[@colinodell]: https://www.twitter.com/colinodell [@jgm]: https://github.com/jgm [jgm/stmd]: https://github.com/jgm/stmd [Composer]: https://getcomposer.org/ +[PHP League]: https://thephpleague.com |