markdown_to_html

You are reading the documentation for Twig 3.x. Switch to the documentation for Twig 1.x, 2.x.

Questions & Feedback

Found a typo or an error?
Want to improve this document? Edit it.

Need support or have a technical question?
Ask support on Stack Overflow.

License

Twig documentation is licensed under the new BSD license.

`markdown_to_html`

The markdown_to_html filter converts a block of Markdown to HTML:

        1
2
3
4
5
6
        {% apply markdown_to_html %}
Title
=====

Hello!
{% endapply %}
    

Note that you can indent the Markdown content as leading whitespaces will be removed consistently before conversion:

        1
2
3
4
5
6
        {% apply markdown_to_html %}
    Title
    =====

    Hello!
{% endapply %}
    

You can also use the filter on an included file or a variable:

        1
2
3
        {{ include('some_template.markdown.twig')|markdown_to_html }}

{{ changelog|markdown_to_html }}
    

Note

The markdown_to_html filter is part of the MarkdownExtension which is not installed by default. Install it first:

        1
        $ composer require twig/markdown-extra
    

Then, on Symfony projects, install the twig/extra-bundle:

        1
        $ composer require twig/extra-bundle
    

Otherwise, add the extension explicitly on the Twig environment:

        1
2
3
4
        use Twig\Extra\Markdown\MarkdownExtension;

$twig = new \Twig\Environment(...);
$twig->addExtension(new MarkdownExtension());
    

If you are not using Symfony, you must also register the extension runtime:

        1
2
3
4
5
6
7
8
9
10
11
        use Twig\Extra\Markdown\DefaultMarkdown;
use Twig\Extra\Markdown\MarkdownRuntime;
use Twig\RuntimeLoader\RuntimeLoaderInterface;

$twig->addRuntimeLoader(new class implements RuntimeLoaderInterface {
    public function load($class) {
        if (MarkdownRuntime::class === $class) {
            return new MarkdownRuntime(new DefaultMarkdown());
        }
    }
});
    

Afterwards you need to install a markdown library of your choice. Some of them are mentioned in the require-dev section of the twig/markdown-extra package.

Note

If using Symfony (full-stack), twig/extra-bundle with league/commonmark as your Markdown library you can configure CommonMark extensions. Register the desired extension(s) as a service, then tag the service with twig.markdown.league_extension.