A Symfony 4 / 5 / 6 bundle to easily configure league/commonmark v2, allowing you to set multiple MarkDown converters.
Simply install it with Composer, an auto-generated recipe will enable the bundle for you:
composer require aymdev/commonmark-bundle
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.
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
)
The options
key holds the configuration passed to the converter, as an array.
For more information, see the CommonMark documentation about Configuration.
The extensions
key allows to add any extension class to a converter.
Check the complete list of extensions on the CommonMark documentation.
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:
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.