Twig

The flexible, fast, and secure
template engine for PHP

a Symfony Product
You are reading the documentation for Twig 3.x. Switch to the documentation for Twig 1.x. 2.x.

Questions & Feedback

License

Twig documentation is licensed under the new BSD license.

html_to_markdownΒΆ

New in version 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 add some options by passing them as an argument to the filter:

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

Note

The options are the ones provided by the league/html-to-markdown package.

You can also use the filter on an included file:

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

Note

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

1
$ composer req twig/markdown-extra

Then, use the twig/extra-bundle on Symfony projects or add the extension explictly on the Twig environment:

use Twig\Extra\Markdown\MarkdownMarkdownExtension;

$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());
        }
    }
});
Website powered by Symfony and Twig, deployed on
The Twig logo is © 2010-2019 Symfony