Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aymdev/commonmarkbundle
A Symfony 4+ bundle to easily configure league/commonmark
https://github.com/aymdev/commonmarkbundle
commonmark markdown php symfony symfony-bundle symfony4 symfony5
Last synced: about 2 months ago
JSON representation
A Symfony 4+ bundle to easily configure league/commonmark
- Host: GitHub
- URL: https://github.com/aymdev/commonmarkbundle
- Owner: AymDev
- License: mit
- Created: 2020-10-09T13:20:50.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-12-04T18:28:14.000Z (about 3 years ago)
- Last Synced: 2024-12-15T22:32:25.286Z (about 2 months ago)
- Topics: commonmark, markdown, php, symfony, symfony-bundle, symfony4, symfony5
- Language: PHP
- Homepage:
- Size: 67.4 KB
- Stars: 7
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# CommonMarkBundle
A **Symfony 4 / 5 / 6** bundle to easily configure [league/commonmark](https://github.com/thephpleague/commonmark) **v2**,
allowing you to set multiple **MarkDown** converters.
[](//packagist.org/packages/aymdev/commonmark-bundle)
[](//packagist.org/packages/aymdev/commonmark-bundle)
- [Installation](#installation)
- [Configuration](#configuration)
- [Converter type](#converter-type)
- [Converter options](#converter-options)
- [Converter extensions](#converter-extensions)
- [Using the converters](#using-the-converters)
- [As services](#as-services)
- [In your templates](#in-your-templates)
## Installation
Simply install it with **Composer**, an auto-generated recipe will enable the bundle for you:
```sh
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:
```yaml
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` with `CommonMarkCoreExtension`
- `github`: `MarkdownConverter` with `GithubFlavoredMarkdownExtension`
- `empty`: an empty `MarkdownConverter` (e.g. to use `InlinesOnlyExtension`)
### Converter options
The `options` key holds the configuration passed to the converter, as an array.
>For more information, see the [CommonMark documentation about Configuration](https://commonmark.thephpleague.com/2.0/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](https://commonmark.thephpleague.com/2.0/extensions/overview/).
## 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**:
```yaml
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*:
```twig
{{ markdown_content|commonmark('my_converter') }}
```
>If you have only 1 *converter* you can ommit the *converter name*.