You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Ryan Weaver 9a8e23f69f minor #117 Abandon this bundle (bocharsky-bw) 5 months ago
.github/workflows Run PHPUnit tests only on PR 5 months ago
DependencyInjection Revert removing Sundown 5 months ago
Helper update test methods to parent signatures 7 months ago
Parser Get rid of property types for now 5 months ago
Resources/config Revert removing Sundown 5 months ago
Twig/Extension remove deprecations 8 months ago
tests Bump Symfony lowest to ^4.4 5 months ago
.gitignore Ignore PHPUnit cache file and var/ dir 5 months ago
.travis.yml add PHP 8 1 year ago
CHANGELOG.md Making the templating component an optional dependency 4 years ago
KnpMarkdownBundle.php Removed hard dependency on MarkdownParser code, now uses `dflydev/markdown` library 10 years ago
LICENSE Initial commit 12 years ago
MarkdownParserInterface.php Reverted the interface renaming done in #50 8 years ago
README.markdown Abandon this bundle 5 months ago
composer.json Abandon this bundle 5 months ago
phpunit.xml.dist Do not fail on incomplete - we do have incomplete tests 5 months ago

README.markdown

WARNING: This bundle is abandoned in favor of markdown_to_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) to your Symfony projects.

Build Status

ci.yml php.yml

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 = $this->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 }}

{# 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:

# 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.

For more details, see the implementations in Parser/Preset.