Download the PHP package aptoma/twig-markdown without Composer
On this page you can find all versions of the php package aptoma/twig-markdown. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package twig-markdown
Twig Markdown Extension
THIS EXTENSION IS NO LONGER MAINTAINED, AND WE WILL NOT MAKE ANY NEW RELEASES. IF ANYONE WANTS TO TAKE OVER, PLEASE MAKE A FORK AND PUBLISH A NEW PACKAGE, AND WE'LL LINK TO THE NEW VERSION.
Twig Markdown extension provides a new filter and a tag to allow parsing of content as Markdown in Twig templates.
This extension could be integrated with several Markdown parser as it provides an interface, which allows you to customize your Markdown parser.
Supported parsers
- michelf/php-markdown (+ MarkdownExtra)
- league/commonmark
- KnpLabs/php-github-api
- erusev/parsedown
Features
- Filter support
{{ "# Heading Level 1"|markdown }}
- Tag support
{% markdown %}{% endmarkdown %}
When used as a tag, the indentation level of the first line sets the default indentation level for the rest of the tag content. From this indentation level, all same indentation or outdented levels text will be transformed as regular text.
This feature allows you to write your Markdown content at any indentation level without caring of Markdown internal transformation:
Installation
Run the composer command to install the latest stable version:
Or update your composer.json
:
You can choose to provide your own Markdown engine, although we recommend using michelf/php-markdown:
You may also use the PHP League CommonMark engine:
Usage
Twig Extension
The Twig extension provides the markdown
tag and filter support.
Assuming that you are using composer autoloading, add the extension to the Twig environment:
Twig Token Parser
The Twig token parser provides the markdown
tag only!
Symfony
To use this extension in a Symfony 3/4 app (including Pimcore), add the following snippet to your app's app/config/services.yml
file:
GitHub Markdown Engine
MarkdownEngine\GitHubMarkdownEngine
provides an interface to GitHub's markdown engine using their public API via KnpLabs\php-github-api
. To reduce API calls, rendered documents are hashed and cached in the filesystem. You can pass a GitHub repository and the path to be used for caching to the constructor:
In order to authenticate the API client (for instance), it's possible to pass an own instance of \GitHub\Client
instead of letting the engine create one itself:
Using a different Markdown parser engine
If you want to use a different Markdown parser, you need to create an adapter
that implements Aptoma\Twig\Extension\MarkdownEngineInterface.php
. Have
a look at Aptoma\Twig\Extension\MarkdownEngine\MichelfMarkdownEngine
for an
example.
Tests
The test suite uses PHPUnit:
$ phpunit
License
Twig Markdown Extension is licensed under the MIT license.