Fixes missing comma for autoloading definition.
2.8 KiB
Provide markdown conversion (based on Michel Fortin work) to your Symfony2 projects.
INSTALLATION
Symfony 2.0) Add the following entry to deps
the run php bin/vendors install
.
[KnpMarkdownBundle]
git=https://github.com/KnpLabs/KnpMarkdownBundle
target=/bundles/Knp/Bundle/MarkdownBundle
[dflydev-markdown]
git=https://github.com/dflydev/dflydev-markdown
target=dflydev-markdown
And register namespace in app/autoload.php
$loader->registerNamespaces(array(
// ...
'dflydev' => __DIR__.'/../vendor/dflydev-markdown/src',
'Knp' => __DIR__.'/../vendor/bundles',
));
Symfony 2.1) Add KnpMarkdownBundle to your composer.json
{
"require": {
"knplabs/knp-markdown-bundle": "1.2.*@dev"
}
}
Symfony 2.0 & 2.1) Register the bundle in app/AppKernel.php
$bundles = array(
// ...
new Knp\Bundle\MarkdownBundle\KnpMarkdownBundle(),
);
USAGE
// Use the service
$html = $this->container->get('markdown.parser')->transformMarkdown($text);
// Use the helper with default parser
echo $view['markdown']->transform($text);
// Use the helper and a select specific parser
echo $view['markdown']->transform($text, $parserName);
If you have enabled the Twig markdown filter, you can use the following in your Twig templates:
{# Use default parser #}
{{ my_data|markdown }}
{# Or select specific parser #}
{{ my_data|markdown('parserName') }}
Change the parser implementation
Create a service implementing Knp\Bundle\MarkdownBundle\MarkdownParserInterface
,
then configure the bundle to use it:
knp_markdown:
parser:
service: my.markdown.parser
Alternatively if you are using the markdown.parser.sundown
there are
options for enabling sundown extensions and render flags, see the
default Configuration with:
php app/console config:dump-reference knp_markdown
This bundle comes with 5 parser services, 4 based on the same algorithm but providing different levels of compliance to the markdown specification, and one which is uses the php sundown extension:
- markdown.parser.max // fully compliant = slower (default implementation)
- markdown.parser.medium // expensive and uncommon features dropped
- markdown.parser.light // expensive features dropped
- markdown.parser.min // most features dropped = faster
- markdown.parser.sundown // faster and fully compliant (recommended)
markdown.parser.sundown
requires the php sundown extension.
For more details, see the implementations in Parser/Preset.
TEST
phpunit -c myapp vendor/bundles/Knp/Bundle/MarkdownBundle