buzzingpixel/twig-markdown

A Twig Markdown filter

1.0.2 2022-03-17 14:35 UTC

Requires

• php: >=7.2
• cebe/markdown: ^1.2
• twig/twig: ^2.10|^3.0

Requires (Dev)

• doctrine/coding-standard: ^9.0
• friendsofphp/php-cs-fixer: ^2.14
• phpmd/phpmd: ^2.6
• phpstan/phpstan: ^1.4
• phpstan/phpstan-deprecation-rules: ^1.0
• phpunit/phpunit: ^8.1
• roave/security-advisories: dev-master
• squizlabs/php_codesniffer: ^3.4
• symfony/var-dumper: ^4.2

Apache-2.0

• TJ Draper

README

Provides markdownParse and markdownParseParagraph filters.

Installation

When instantiating your Twig instance, add MarkdownTwigExtension to Twig via the addExtension() method. Like so:

<?php
declare(strict_types=1);

use Twig\Environment;
use Twig\Loader\FilesystemLoader;
use BuzzingPixel\TwigMarkdown\MarkdownTwigExtension;

$twig = new Environment(new FilesystemLoader('/path/to/templates'), [
    'debug' => true,
    'cache' => '/path/to/cache',
    'strict_variables' => true,
]);

$twig->addExtension($myDiContainer->get(MarkdownTwigExtension::class));

Usage

Note that some of the examples below pass in the markdown flavor. The default is Github Flavored Markdown (github). You can also pass in markdown for pure markdown, or extra for Markdown Extra.

{{ myVar|markdownParse('markdown') }}

{{ myVar|markdownParseParagraph('extra') }}

{% filter markdownParse %}
    Lorem ipsum dolor sit amet, consectetur adipisicing elit. Aliquam cumque dolorem enim error facere fuga hic magni nulla quaerat, quas, quidem ratione repellat voluptatem. Alias aperiam beatae consectetur qui sequi!
{% endfilter %}

{% filter markdownParseParagraph('markdown') %}
    Lorem ipsum dolor sit amet, consectetur adipisicing elit. Aliquam cumque dolorem enim error facere fuga hic magni nulla quaerat, quas, quidem ratione repellat voluptatem. Alias aperiam beatae consectetur qui sequi!
{% endfilter %}

License

Copyright 2022 BuzzingPixel, LLC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.