tanuck/cakephp-markdown

Cakephp Markdown plugin for CakePHP 3.

v0.1.0 2015-02-20 22:16 UTC

Requires

• php: >=5.4
• cakephp/plugin-installer: *
• cebe/markdown: 1.0.x

Requires (Dev)

• cakephp/cakephp: 3.0.*-dev
• cakephp/cakephp-codesniffer: dev-master
• phpunit/phpunit: *

MIT

• Tanuck

README

CakePHP 3 plugin to parse markdown syntax in your view templates.

Installation

Include the following in your composer.json file:

    "require": {
        "tanuck/cakephp-markdown": "dev-master"
    }

and then run:

composer update

Configuration & Usage

To your config/bootstrap.php file add Plugin::load('Tanuck/Markdown');

Then, load the helper where needed. For example, in your controller:

    class FooController extends AppController
    {
        public $helpers = ['Tanuck/Markdown.Markdown'];
    }

then in your templates, you can output markdown syntax like so:

    echo $this->Markdown->transform($myMarkdownSyntax);

Advanced Configuration

Markdown is rendered using the cebe/markdown library which offers 3 different markdown parser classes.

• Markdown - using the original syntax definition: http://daringfireball.net/projects/markdown/syntax
• GithubMarkdown - GitHubs own markdown flavour: https://help.github.com/articles/github-flavored-markdown/
• MarkdownExtra - an extension of the original by michelf: http://michelf.ca/projects/php-markdown/extra/

By default, the plugin will use Markdown, the first of the 3 above. However you can specify which of the 3 you use wish to use when loading the helper. Like so:

    class FooController extends AppController
    {
        public $helpers = [
            'Tanuck/Markdown.Markdown' => [
                'parser' => 'GithubMarkdown'
            ]
        ];
    }

License

cakephp-markdown is offered under an MIT license.