html_to_markdown

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

Warning Twig version 2.x is no longer maintained.

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.

`html_to_markdown`

2.12

The html_to_markdown filter was added in Twig 2.12.

The html_to_markdown filter converts a block of HTML to Markdown:

        1
2
3
4
5
        {% apply html_to_markdown %}
    <html>
        <h1>Hello!</h1>
    </html>
{% endapply %}
    

You can also use the filter on an entire template which you include:

        1
        {{ include('some_template.html.twig')|html_to_markdown }}
    

Note

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

        1
        $ composer require twig/markdown-extra
    

On Symfony projects, you can automatically enable it by installing the twig/extra-bundle:

        1
        $ composer require twig/extra-bundle
    

Or 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());
        }
    }
});
    

html_to_markdown is just a frontend; the actual conversion is done by one of the following compatible libraries, from which you can choose:

Depending on the library, you can also add some options by passing them as an argument to the filter. Example for league/html-to-markdown:

        1
2
3
4
5
        {% apply html_to_markdown({hard_break: false}) %}
    <html>
        <h1>Hello!</h1>
    </html>
{% endapply %}
    