evandotpro / edp-markdown
A minimalist ZF2 module for adding markdown support to Zend Framework 2 projects
Installs: 8 733
Dependents: 0
Suggesters: 0
Security: 0
Stars: 33
Watchers: 4
Forks: 10
Open Issues: 2
Requires
- michelf/php-markdown: ~1.4
- zendframework/zend-view: 2.*
This package is not auto-updated.
Last update: 2024-10-26 16:02:28 UTC
README
Version 0.0.1 Created by Evan Coury
Introduction
This ZF2 module simply adds Markdown support to your project. It utilizes the PHP Markdown library written by Michel Fortin which is a PHP port of the original perl implementation by John Gruber.
Installation
To install EdpMarkdown, simply recursively clone this repository (git clone --recursive) into your ZF2 modules directory and enable it in your
config/application.config.php file. That's it!
Usage
With this module installed, using Markdown in your view scripts is easy:
<?= $this->markdown('Hello, **this** is _Markdown_!'); ?>
NOTE: For security purposes, the output SHOULD be sanitized if the Markdown is from an untrusted source. (@padraic says so!) See the Markdown documentation on inline HTML to understand why this is necessary.
Configuration
TODO: Create simple way to toggle to the 'extra' parser.
License
EdpMarkdown is released under the New BSD license. See the included LICENSE file.
PHP Markdown is available under the New BSD or the GNU GPL v2.