mirror of
https://github.com/KnpLabs/KnpMarkdownBundle.git
synced 2024-06-29 10:50:23 +02:00
105 lines
3.3 KiB
Markdown
105 lines
3.3 KiB
Markdown
Provide markdown conversion (based on [Michel Fortin work](https://github.com/michelf/php-markdown)) to your Symfony projects.
|
|
|
|
[](http://travis-ci.org/KnpLabs/KnpMarkdownBundle)
|
|
|
|
|
|
## Versions and PHP Support
|
|
|
|
| Version | Symfony | PHP |
|
|
| ------------------------------------------------------------------------------- | ---------------------- | ---------------- |
|
|
| [2.0 (master)](https://github.com/KnpLabs/KnpMarkdownBundle/tree/master) | ^4.4 and ^5.3 and ^6.0 | >=8.0 |
|
|
| [1.x](https://github.com/KnpLabs/KnpMarkdownBundle/tree/master) | ~3.4 and ^4.0 and ^5.0 | ^7.1.3 and ^8.0 |
|
|
|
|
## INSTALLATION
|
|
|
|
Add KnpMarkdownBundle to your project via [Composer](https://getcomposer.org/):
|
|
|
|
```
|
|
composer require knplabs/knp-markdown-bundle
|
|
```
|
|
|
|
If you're *not* using Symfony Flex, you will also need to enable
|
|
the bundle in your `config/bundles.php` file
|
|
```
|
|
Knp\Bundle\MarkdownBundle::class => ['all' => true],
|
|
```
|
|
|
|
That's it! Start using it!
|
|
|
|
## USAGE
|
|
|
|
Once the bundle is installed, you can autowire a `MarkdownParserInterface`
|
|
into any service or controller:
|
|
|
|
```php
|
|
use Knp\Bundle\MarkdownBundle\MarkdownParserInterface;
|
|
|
|
// from inside a controller
|
|
public function index(MarkdownParserInterface $parser)
|
|
{
|
|
$html = $parser->transformMarkdown($text);
|
|
}
|
|
|
|
// or from inside a service
|
|
private $parser;
|
|
|
|
public function __construct(MarkdownParserInterface $parser)
|
|
{
|
|
$this->parser = $parser;
|
|
}
|
|
|
|
public function someMethod()
|
|
{
|
|
$html = $this->parser->transformMarkdown($text);
|
|
}
|
|
```
|
|
|
|
There is also a public `markdown.parser` service you can use.
|
|
|
|
In Twig, you can use the `markdown` filter:
|
|
|
|
```twig
|
|
{# Use default parser #}
|
|
{{ my_data|markdown }}
|
|
|
|
{# If my_data is entered by a user, escape HTML tags before printing it #}
|
|
{{ my_data|escape|markdown }}
|
|
{# or strip HTML tags #}
|
|
{{ my_data|striptags|markdown }}
|
|
|
|
{# Or select specific parser #}
|
|
{{ my_data|markdown('parserName') }}
|
|
```
|
|
|
|
## Change the parser implementation
|
|
|
|
Create a service implementing `Knp\Bundle\MarkdownBundle\MarkdownParserInterface`,
|
|
then configure the bundle to use it:
|
|
|
|
```yaml
|
|
# Symfony 4: config/packages/knp_markdown.yaml (you'll need to create this)
|
|
knp_markdown:
|
|
parser:
|
|
service: my.markdown.parser
|
|
```
|
|
|
|
Alternatively if you are using the ``markdown.parser.sundown`` there are
|
|
options for enabling sundown extensions and render flags, see the
|
|
default Configuration with:
|
|
|
|
php bin/console config:dump-reference knp_markdown
|
|
|
|
This bundle comes with 5 parser services, 4 based on the same algorithm
|
|
but providing different levels of compliance to the markdown specification,
|
|
and one which is uses the php sundown extension:
|
|
|
|
- markdown.parser.max // fully compliant = slower (default implementation)
|
|
- markdown.parser.medium // expensive and uncommon features dropped
|
|
- markdown.parser.light // expensive features dropped
|
|
- markdown.parser.min // most features dropped = faster
|
|
- markdown.parser.sundown // faster and fully compliant (recommended)
|
|
|
|
``markdown.parser.sundown`` requires the [php sundown extension](https://github.com/chobie/php-sundown).
|
|
|
|
For more details, see the implementations in Parser/Preset.
|