README

Introduction

MaglMarkdown is a ZF2 module that adds a View Helper to transform Markdown. To change between different renderers have a look at the config section

You can use one of the following parsers for your Markdown:

The PHP-Markdown parser from Michel Fortin
The PHP-MarkdownExtra parser from Michel Fortin (this is the default)
The Parsedown parser from Emanuil Rusev
The Parsedown-Extra parser from Emanuil Rusev
Github Markdown Api
- you should provide an access_token within the config, to avoid hitting the rate_limit too soon
- it's highly recommended to enable caching if you use the Github Api because of the mentioned rate_limit and to boost performance
The PHP League's CommonMark implementation

Installation

You can install the module with composer by adding the following "require" to your composer.json

{
	"require": {
		"maglnet/magl-markdown": "~1.1"
	}
}

after that you need to run

$ php composer.phar update

and enable the module within your application.config.php

array(
	'modules' => array(
		'Application',
		'MaglMarkdown',
	),
);

Usage

View Helper

Simply use it within your Views like this

$this->markdown('Yes, **this** is *Markdown*!');

Service Manager

You can get the MarkdownService through the Service Manager, to use the render() method wherever you like within you zf2 application. MarkdownService automatically uses caching if it has been enabled within the config.

/* @var $markdownService MaglMarkdown\Service\Markdown */
$markdownService = $serviceManager->get('MaglMarkdown\MarkdownService');
$html = $markdownService->render('Yes, **this** is *Markdown*!');

You can also get a MarkdownAdapter through the Service Manager and use transformText() to get your Markdown rendered to HTML.
This is NOT recommended anymore. Use the above mentioned MarkdownService instead because it can use the provided caching mechanism.

/* @var $markdownAdapter MaglMarkdown\Adapter\MarkdownAdapterInterface */
$markdownAdapter = $serviceManager->get('MaglMarkdown\MarkdownAdapter');
$html = $markdownAdapter->transformText('Yes, **this** is *Markdown*!');

Security warning:
You should be aware, that your markdown could contain insecure content (e.g. user generated content). So use something like HTMLPurifier to sanitize your output.

Configuration

Copy the provided config file config/maglmarkdown.local.php to your autoloading directory YourZF2Application/config/autoload/maglmarkdown.local.php and adjust it to your needs.
By default PHP-MarkdownExtra parser by Michel Fortin is used.

Cache

By default, caching is disabled. Set cache_enabled to true within config/maglmarkdown.local.php to enable the caching. Caching could be very helpful if you have large markdown files/texts or if you're using an Adapter that relies on third-party APIs that either are rate limited or take a long time to render.

A simple filesystem cache is configured by default, but feel free to configure your own adapter.

Adding own parsers

It is possible to add your own parser implementation.
All you have to do, is to write a class that implements the MaglMarkdown\Adapter\MarkdownAdapterInterface interface and make it available through the service manager.
After that override the alias MaglMarkdown\MarkdownAdapterto point to your custom adapter.
MaglMarkdown will then use this class to transform the Markdown.

array(
	'aliases' => array(
		'MaglMarkdown\MarkdownAdapter' => 'Your\Own\MarkdownAdapter', //needs to implement MaglMarkdown\Adapter\MarkdownAdapterInterface
	),
)

Events

The markdown service triggers two events you can listen to:

markdown.render.pre before rendering (with the markdown text as parameter)
markdown.render.post after rendering (with the rendered markdown as parameter)

These events are currently used for the integrated caching feature only, but do whatever you like with these events.

Contributors

MaglMarkdown is developed by Matthias Glaub and contributors.

License

MaglMarkdown is licensed under the MIT license.
See the included LICENSE file.

maglnet / magl-markdown

Maintainers

Details