plumphp/plum-markdown

Markdown converters for Plum. Plum is a data processing pipeline for PHP.

v0.1.1 2015-04-28 20:37 UTC

README

PlumMarkdown is a Markdown converter using PHP Markdown for Plum. Plum is a data processing pipeline for PHP.

Build Status Windows Build status Scrutinizer Code Quality Code Coverage StyleCI

Developed by Florian Eckerstorfer in Vienna, Europe.

Installation

You can install Plum using Composer.

$ composer require plumphp/plum-markdown

Usage

Please refer to the Plum documentation for more information about Plum in general.

PlumMarkdown contains Plum\PlumMarkdown\MarkdownConverter to convert Markdown into HTML.

MarkdownConverter

The Plum\PlumMarkdown\MarkdownConverter converts Markdown into HTML.

use Plum\PlumMarkdown\MarkdownConverter;

$converter = new MarkdownConverter();
$converter->convert('*foobar*'); // -> "<p><em>foobar</em></p>

You can pass an instance of Michelf\MarkdownInterface to the constructor to set the markdown processor you want to use.

Change Log

Version 0.1.1 (28 April 2015)

  • Fix Plum version

Version 0.1 (22 April 2015)

  • Initial release

Author

Plum and PlumMarkdown have been developed by Florian Eckerstorfer (Twitter) in Vienna, Europe.

Plum is a project of Cocur. You can contact us on Twitter: @cocurco

License

The MIT license applies to plumphp/plum-markdown. For the full copyright and license information, please view the LICENSE file distributed with this source code.