summaryrefslogtreecommitdiff
path: root/vendor/league/commonmark/README.md
diff options
context:
space:
mode:
authorGreg Roach <fisharebest@webtrees.net>2019-11-04 23:56:19 +0000
committerGreg Roach <fisharebest@webtrees.net>2019-11-04 23:56:19 +0000
commit09a0b4fc622e4780bc0c9e9dd7ec6a13a03dbf4f (patch)
tree93468cbf4a24a1f025c22abb102757081892503b /vendor/league/commonmark/README.md
parent35b016d961c6f782ac75e89afa6ca4acd0773662 (diff)
downloadwebtrees-09a0b4fc622e4780bc0c9e9dd7ec6a13a03dbf4f.tar.gz
webtrees-09a0b4fc622e4780bc0c9e9dd7ec6a13a03dbf4f.tar.bz2
webtrees-09a0b4fc622e4780bc0c9e9dd7ec6a13a03dbf4f.zip
Update vendor dependencies
Diffstat (limited to 'vendor/league/commonmark/README.md')
-rw-r--r--vendor/league/commonmark/README.md35
1 files changed, 27 insertions, 8 deletions
diff --git a/vendor/league/commonmark/README.md b/vendor/league/commonmark/README.md
index 301b0103d1..12df509f47 100644
--- a/vendor/league/commonmark/README.md
+++ b/vendor/league/commonmark/README.md
@@ -62,15 +62,20 @@ Information on how to upgrade to newer versions of this library can be found at
- [Twig Markdown extension](https://github.com/twigphp/markdown-extension)
- [Twig filter and tag](https://github.com/aptoma/twig-markdown)
-### League Extensions
+### GFM Extensions
-The PHP League offers useful extensions that add extra syntax and features:
+You can easily add support for Github-Flavored Markdown by installing the [`league/commonmark-extras`](https://github.com/thephpleague/commonmark-extras) package, which includes bundles all of the extensions listed below:
+
+| Feature | Package Name | Description |
+| ------- | ------------ | ----------- |
+| Autolinks | [`league/commonmark-ext-autolink`](https://github.com/thephpleague/commonmark-ext-autolink) | Automatically links URLs, emails, and (optionally) @-mentions without needing to use `<...>` |
+| Smart Punctuation | [`league/commonmark-ext-smartpunct`](https://github.com/thephpleague/commonmark-ext-smartpunct) | Intelligently converts ASCII quotes, dashes, and ellipses to their Unicode equivalents |
+| Strikethrough | [`league/commonmark-ext-strikethrough`](https://github.com/thephpleague/commonmark-ext-strikethrough) | Adds support for `~~strikethrough~~` syntax |
+| Task Lists | [`league/commonmark-ext-task-list`](https://github.com/thephpleague/commonmark-ext-task-list) | Support for Github-style task lists |
+| Tables | [`league/commonmark-ext-table`](https://github.com/thephpleague/commonmark-ext-table) | GFM-style tables |
+
+### Other PHP League Extensions
- - [`league/commonmark-extras`](https://github.com/thephpleague/commonmark-extras) - Bundles the extensions below into a single dependency for convenience
- - [`league/commonmark-ext-autolink`](https://github.com/thephpleague/commonmark-ext-autolink) - Extension for league/commonmark which autolinks URLs, emails, and (optionally) @-mentions
- - [`league/commonmark-ext-smartpunct`](https://github.com/thephpleague/commonmark-ext-smartpunct) - Intelligently converts ASCII quotes, dashes, and ellipses to their Unicode equivalents
- - [`league/commonmark-ext-strikethrough`](https://github.com/thephpleague/commonmark-ext-strikethrough) - Adds support for `~~strikethrough~~` syntax
- - [`league/commonmark-ext-task-list`](https://github.com/thephpleague/commonmark-ext-task-list) - Support for Github-style task lists
- [`league/commonmark-ext-inlines-only`](https://github.com/thephpleague/commonmark-ext-inlines-only) - Renders inline text without paragraph tags or other block-level elements
- [`league/commonmark-ext-external-link`](https://github.com/thephpleague/commonmark-ext-external-link) - Mark external links, make them open in new windows, etc.
@@ -80,7 +85,6 @@ You can add them to your project or use them as examples to [develop your own cu
Custom parsers/renderers can be bundled into extensions which extend CommonMark. Here are some that you may find interesting:
- - [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.
- [Sup Sub extensions](https://github.com/OWS/commonmark-sup-sub-extensions) - Adds support of superscript and subscript (`<sup>` and `<sub>` HTML tags)
@@ -107,6 +111,8 @@ When a new **major** version is released (`1.0`, `2.0`, etc), the previous one (
(This policy may change in the future and exceptions may be made on a case-by-case basis.)
+**Professional support, including notification of new releases and security updates, is available through a [Tidelift Subscription](https://tidelift.com/subscription/pkg/packagist-league-commonmark?utm_source=packagist-league-commonmark&utm_medium=referral&utm_campaign=readme).**
+
## 👷‍♀️ Contributing
To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure with us.
@@ -152,6 +158,7 @@ This code is partially based on the [CommonMark JS reference implementation][com
We'd also like to extend our sincere thanks the following sponsors who support ongoing development of this project:
+ - [Tidelift](https://tidelift.com/subscription/pkg/packagist-league-commonmark?utm_source=packagist-league-commonmark&utm_medium=referral&utm_campaign=readme) for offering support to both the maintainers and end-users through their [professional support](https://tidelift.com/subscription/pkg/packagist-league-commonmark?utm_source=packagist-league-commonmark&utm_medium=referral&utm_campaign=readme) program
- [RIPS Technologies](https://www.ripstech.com/) for supporting this project with a complimentary [RIPS SaaS](https://www.ripstech.com/product/) license
- [JetBrains](https://www.jetbrains.com/) for supporting this project with complimentary [PhpStorm](https://www.jetbrains.com/phpstorm/) licenses
@@ -165,6 +172,18 @@ Are you interested in sponsoring development of this project? [Make a pledge](ht
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.
+---
+
+<div align="center">
+ <b>
+ <a href="https://tidelift.com/subscription/pkg/packagist-league-commonmark?utm_source=packagist-league-commonmark&utm_medium=referral&utm_campaign=readme">Get professional support for league/commonmark with a Tidelift subscription</a>
+ </b>
+ <br>
+ <sub>
+ Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
+ </sub>
+</div>
+
[CommonMark]: http://commonmark.org/
[CommonMark spec]: http://spec.commonmark.org/
[commonmark.js]: https://github.com/jgm/commonmark.js