bretrzaun/silex-markdown

This package is abandoned and no longer maintained. No replacement package was suggested.

A lightweight markdown service provider for Silex

2.0.0 2017-02-04 15:31 UTC

Requires

• php: >=7.0
• michelf/php-markdown: ^1.0
• silex/silex: ^2.0

Requires (Dev)

• phpunit/phpunit: ^6.0
• twig/twig: ^1.18

Suggests

• twig/twig: enables parsing markdown right from the template using simple filter

MIT

• Bret R. Zaun

• silex
• markdown

README

A lightweight markdown service provider for Silex. Uses the michelf/php-markdown markdown parser.

Based on: nicl/silex-markdown

Installation

Recommended installation is through composer. Just add the following to your composer.json file:

{
    "require": {
        "bretrzaun/silex-markdown": "^1.0"
    }
}

Usage

To use the service provider first register it:

$app->register(new MarkdownServiceProvider());

You can then use the markdown filter in Twig files. For example:

{{ '#Hello World'|markdown }}

In addition, you also have access to the Markdown parser itself. Simply instantiate it and call the transform method as follows:

$app['markdown']->transform($txt);

Configuration

Parameters

• markdown.factory: Name of the service that will create Michelf\MarkdownInterface instances, string.

• markdown.parser: Name of the built-in parser to use, string. Default: markdown

  Available options:

  • markdown: Standard Markdown parser
  • extra: Markdown Extra parser

Services

• markdown: Markdown parser, instance of Michelf\MarkdownInterface.

Tests

If you wish to run the tests then, from the silex-markdown root directory run:

composer test