https://github.com/KnpLabs/KnpMarkdownBundle
Symfony wrapper for PHP markdown
https://github.com/KnpLabs/KnpMarkdownBundle
symfoy-bundle
Last synced: 8 months ago
JSON representation
Symfony wrapper for PHP markdown
- Host: GitHub
- URL: https://github.com/KnpLabs/KnpMarkdownBundle
- Owner: KnpLabs
- License: mit
- Archived: true
- Created: 2010-05-05T15:05:02.000Z (over 15 years ago)
- Default Branch: master
- Last Pushed: 2022-02-01T17:07:08.000Z (almost 4 years ago)
- Last Synced: 2025-04-06T15:18:44.035Z (8 months ago)
- Topics: symfoy-bundle
- Language: PHP
- Homepage: http://knplabs.com/
- Size: 278 KB
- Stars: 411
- Watchers: 30
- Forks: 50
- Open Issues: 0
-
Metadata Files:
- Readme: README.markdown
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-symfony - KnpMarkdownBundle - Wrapper for PHP markdown. (Miscellaneous)
README
> **WARNING:** This bundle is **abandoned** in favor of [markdown_to_html](https://twig.symfony.com/doc/3.x/filters/markdown_to_html.html)
> Twig filter. Please, consider using it instead. Migration should be easy because it also supports
> `michelf/php-markdown` Markdown parser that is used in this project under the hood.
Provide markdown conversion (based on [Michel Fortin work](https://github.com/michelf/php-markdown)) to your Symfony projects.
[](http://travis-ci.org/KnpLabs/KnpMarkdownBundle)
## INSTALLATION
Add KnpMarkdownBundle to your project via [Composer](https://getcomposer.org/):
```
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:
```php
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 = $this->parser->transformMarkdown($text);
}
```
There is also a public `markdown.parser` service you can use.
In Twig, you can use the `markdown` filter:
```twig
{# Use default parser #}
{{ my_data|markdown }}
{# If my_data is entered by a user, escape HTML tags before printing it #}
{{ my_data|escape|markdown }}
{# or strip HTML tags #}
{{ my_data|striptags|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:
```yaml
# Symfony 3: app/config/config.yml
# Symfony 4: config/packages/knp_markdown.yaml (you'll need to create this)
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 bin/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](https://github.com/chobie/php-sundown).
For more details, see the implementations in Parser/Preset.