Knplabs markdown bundle transforms markdown into html

Installs: 631 279

Dependents: 48

Stars: 169

Watchers: 31

Forks: 37

Open Issues: 4

Type: symfony-bundle

1.5.1 2016-05-04 16:08 UTC


Provide markdown conversion (based on Michel Fortin work) to your Symfony2 projects.

Build Status

Add KnpMarkdownBundle to your project via Composer:

composer require knplabs/knp-markdown-bundle

Based on your Composer install, you might need to use php composer.phar require knplabs/knp-markdown-bundle.

Next, register the bundle in app/AppKernel.php

$bundles = array(
    // ...
    new Knp\Bundle\MarkdownBundle\KnpMarkdownBundle(),


// Use the service
$html = $this->container->get('markdown.parser')->transformMarkdown($text);

// Use the helper with default parser
echo $view['markdown']->transform($text);

// Use the helper and a select specific parser
echo $view['markdown']->transform($text, $parserName);

If you have enabled the Twig markdown filter, you can use the following in your Twig templates:

{# Use default parser #}
{{ my_data|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:

        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 app/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.

For more details, see the implementations in Parser/Preset.


phpunit -c myapp vendor/bundles/Knp/Bundle/MarkdownBundle