diff options
Diffstat (limited to 'vendor/league/commonmark/src/Extension/Strikethrough/README.md')
| -rw-r--r-- | vendor/league/commonmark/src/Extension/Strikethrough/README.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/vendor/league/commonmark/src/Extension/Strikethrough/README.md b/vendor/league/commonmark/src/Extension/Strikethrough/README.md new file mode 100644 index 0000000000..c93f622161 --- /dev/null +++ b/vendor/league/commonmark/src/Extension/Strikethrough/README.md @@ -0,0 +1,27 @@ +# Strikethrough support for `league/commonmark` + +This extension adds strikethrough Markdown support for the [league/commonmark](link-league-commonmark) PHP Markdown parsing engine, which itself is based on the CommonMark spec. + +It allows users to use `~~` in order to indicate text that should be rendered within `<del>` tags. + +## Usage + +Extensions can be added to any new `Environment`: + +```php +use League\CommonMark\CommonMarkConverter; +use League\CommonMark\Environment; +use League\CommonMark\Extension\Strikethrough\StrikethroughExtension; + +// Obtain a pre-configured Environment with all the CommonMark parsers/renderers ready-to-go +$environment = Environment::createCommonMarkEnvironment(); + +// Add this extension +$environment->addExtension(new StrikethroughExtension()); + +// Instantiate the converter engine and start converting some Markdown! +$converter = new CommonMarkConverter($config, $environment); +echo $converter->convertToHtml('This extension is ~~good~~ great!'); +``` + +[link-league-commonmark]: https://github.com/thephpleague/commonmark |