Download the PHP package aymdev/commonmark-bundle without Composer
On this page you can find all versions of the php package aymdev/commonmark-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download aymdev/commonmark-bundle
More information about aymdev/commonmark-bundle
Files in aymdev/commonmark-bundle
Package commonmark-bundle
Short Description Symfony bundle integrating League CommonMark for Symfony 4.4+ applications
License MIT
Informations about the package commonmark-bundle
CommonMarkBundle
A Symfony 4 / 5 / 6 bundle to easily configure league/commonmark v2, allowing you to set multiple MarkDown converters.
- Installation
- Configuration
- Converter type
- Converter options
- Converter extensions
- Using the converters
- As services
- In your templates
Installation
Simply install it with Composer, an auto-generated recipe will enable the bundle for you:
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:
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:
In your templates
You can use the commonmark
Twig filter. You only need to pass it a converter name:
If you have only 1 converter you can ommit the converter name.
All versions of commonmark-bundle with dependencies
symfony/http-kernel Version ^4.4|^5.0|^6.0
symfony/dependency-injection Version ^4.4|^5.0|^6.0
symfony/config Version ^4.4|^5.0|^6.0
league/commonmark Version ^2.0
symfony/framework-bundle Version ^4.4|^5.0|^6.0