aymdev / commonmark-bundle
Symfony bundle integrating League CommonMark for Symfony 4.4+ applications
Installs: 2 062
Dependents: 0
Suggesters: 0
Security: 0
Stars: 7
Watchers: 3
Forks: 0
Open Issues: 0
Type:symfony-bundle
Requires
- php: ^7.4||^8.0
- league/commonmark: ^2.0
- symfony/config: ^4.4|^5.0|^6.0
- symfony/dependency-injection: ^4.4|^5.0|^6.0
- symfony/framework-bundle: ^4.4|^5.0|^6.0
- symfony/http-kernel: ^4.4|^5.0|^6.0
Requires (Dev)
- dealerdirect/phpcodesniffer-composer-installer: ^0.7.1
- phpcompatibility/php-compatibility: ^9.3
- phpstan/extension-installer: ^1.1
- phpstan/phpstan: ^1.2
- phpstan/phpstan-strict-rules: ^1.1
- sebastian/phpcpd: ^6.0
- squizlabs/php_codesniffer: ^3.6
- symfony/filesystem: ^5.1|^6.0
- symfony/phpunit-bridge: ^4.4|^5.0|^6.0
- symfony/twig-bundle: ^4.4|^5.0|^6.0
- symfony/yaml: ^4.4|^5.0|^6.0
This package is auto-updated.
Last update: 2024-11-05 01:09:38 UTC
README
A Symfony 4 / 5 / 6 bundle to easily configure league/commonmark v2, allowing you to set multiple MarkDown converters.
Installation
Simply install it with Composer, an auto-generated recipe will enable the bundle for you:
composer require aymdev/commonmark-bundle
Configuration
No converter is created by default.
Create a YAML configuration file at path config/packages/aymdev_commonmark.yaml
.
Here is an example configuration declaring 2 converters:
aymdev_commonmark: converters: # add any converter here my_converter: type: 'github' options: enable_strong: true use_underscore: false blog_post_converter: type: 'commonmark' extensions: - League\CommonMark\Extension\HeadingPermalink\HeadingPermalinkExtension
Note that all keys inside a converter are optional.
Converter type
The type
key can be used to choose between a CommonMark or a GitHub converter:
commonmark
(default):MarkdownConverter
withCommonMarkCoreExtension
github
:MarkdownConverter
withGithubFlavoredMarkdownExtension
empty
: an emptyMarkdownConverter
(e.g. to useInlinesOnlyExtension
)
Converter options
The options
key holds the configuration passed to the converter, as an array.
For more information, see the CommonMark documentation about Configuration.
Converter extensions
The extensions
key allows to add any extension class to a converter.
Check the complete list of extensions on the CommonMark documentation.
Using the converters
As services
The bundle registers your converters as services with the converter name as the service ID.
It also creates an alias, so you can get them by autowiring using the converter name as the argument name,
type with the League\CommonMark\MarkdownConverter
class.
Example YAML configuration:
aymdev_commonmark: converters: # You can add an argument for this converter as: # MarkdownConverter $myConverter my_converter:
In your templates
You can use the commonmark
Twig filter. You only need to pass it a converter name:
{{ markdown_content|commonmark('my_converter') }}
If you have only 1 converter you can ommit the converter name.