buzzingpixel/twig-markdown

There is no license information available for the latest version (1.0.0) of this package.

A Twig Markdown filter

1.0.0 2019-05-18 20:04 UTC

README

68747470733a2f2f7472617669732d63692e6f72672f62757a7a696e67706978656c2f747769672d6d61726b646f776e2e7376673f6272616e63683d6d6173746572

Provides markdownParse and markdownParseParagraph filters.

Installation

If you're using Corbomite Twig, the extension will automatically be made available. Otherwise: When instantiating your Twig instance, add MarkdownTwigExtension to Twig via the addExtension() method. Like so:

<?php
declare(strict_types=1);

use corbomite\di\Di;
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(Di::diContainer()->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 2019 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.