Updating README to reflect how we do things now
2.5 KiB
Provide markdown conversion (based on Michel Fortin work) to your Symfony2 projects.
INSTALLATION
Add KnpMarkdownBundle to your project via Composer:
composer require knplabs/knp-markdown-bundle
If you're not using Symfony Flex, you will also need to enable
the bundle in your app/AppKernel.php
file
(new Knp\Bundle\MarkdownBundle\KnpMarkdownBundle()
).
That's it! Start using it!
USAGE
Once the bundle is installed, you can autowire a MarkdownParserInterface
into any service or controller:
use Knp\Bundle\MarkdownBundle\MarkdownParserInterface;
// from inside a controller
public function index(MarkdownParserInterface $parser)
{
$html = $parser->transformMarkdown($text);
}
// or from inside a service
private $parser;
public function __construct(MarkdownParserInterface $parser)
{
$this->parser = $parser;
}
public function someMethod()
{
$html = $parser->transformMarkdown($text);
}
There is also a public markdown.parser
service you can use.
In Twig, you can use the markdown
filter:
{# 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.