cwbit/cakephp-markdown

View Helper for Cake 3.x that enables parsing Markdown into HTML

cakephp-markdown

View Helper Plugin for CakePHP 3.x that enables conversion of Markdown into HTML, _(*1)

WHY?, _(*2)

Because Markdown is super sexy and is a great way to allow for user-friendly editing with the HTML generated at runtime (or cached, or whatever you want to do), _(*3)

HOW?, _(*4)

Just add the Markdown.Markdown Helper to your view and use it. Easy peasy., _(*5)

Requirements

• PHP 5.4+
• CakePHP 3.x
• erusev/Parsedown

TOC

1. Plugin Installation
2. Usage
3. Contributing

Plugin Installation

This plugin is on Packagist which means it can be easily installed with Composer., _(*6)

composer require cwbit/cakephp-markdown "~1.0"

Then simply load the plugin normally in your config/bootstrap.php file, _(*7)

# in ../config/bootstrap.php - right after Plugin::load('Migrations') is fine!
Plugin::load('Markdown');

Manual installation is neither supported nor recommended - just drop the MarkdownHelper in your src\View\Helper and change the namespaces and stuff., _(*8)

Usage

First, make sure you loaded the plugin (see above), _(*9)

Then, Add the MarkdownHelper thru AppView or however you prefer to load helpers, _(*10)

namespace App\View;

use Cake\View\View;

class AppView extends View
{
    public function initialize()
    {
        parent::initialize();
        # ..
        $this->loadHelper('Markdown.Markdown');
    }
}

Then, in a Template file, use the helper, _(*11)

<div class="description">
    <?= $this->Markdown->toHtml($entity->description); ?>
</div>

Contributing

If you'd like to contribute, please submit a PR with your changes!, _(*12)

Requests will be accepted more readily if they come complete with TESTS :D, _(*13)