maurymmarques/markdown-plugin

A CakePHP plugin that facilitates the use of PHP Markdown with CakePHP

Markdown plugin for CakePHP

This plugin facilitates the use of PHP Markdown with CakePHP, _(*1)

PHP Markdown is a port to PHP of the Markdown program written by John Gruber., _(*2)

“Markdown” is two things: a plain text markup syntax, and a software tool that converts the plain text markup to HTML for publishing on the web., _(*3)

More info: http://michelf.com/projects/php-markdown, _(*4)

For this plugin, the application Markdown is inside Vendor, _(*5)

Version

Written for CakePHP 2.x, _(*6)

Copyright

Copyright (c) 2011 Maury M. Marques, _(*7)

Installation

You can install this plugin using Composer, GIT Submodule, GIT Clone or Manually, _(*8)

[Using Composer], _(*9)

Add the plugin to your project's composer.json - something like this:, _(*10)

{
  "require": {
    "maurymmarques/markdown-plugin": "dev-master"
  },
  "extra": {
    "installer-paths": {
      "app/Plugin/Markdown": ["maurymmarques/markdown-plugin"]
    }
  }
}

Then just run composer install, _(*11)

Because this plugin has the type cakephp-plugin set in it's own composer.json, composer knows to install it inside your /Plugin directory, rather than in the usual vendors file., _(*12)

[GIT Submodule], _(*13)

In your app directory (app/Plugin) type:, _(*14)

git submodule add git://github.com/maurymmarques/markdown-cakephp.git Plugin/Markdown
git submodule init
git submodule update

[GIT Clone], _(*15)

In your plugin directory (app/Plugin or plugins) type:, _(*16)

git clone https://github.com/maurymmarques/markdown-cakephp.git Markdown

[Manual], _(*17)

• Download the Markdown archive.
• Unzip that download.
• Rename the resulting folder to Markdown
• Then copy this folder into app/Plugin/ or plugins

Configuration

Bootstrap the plugin in app/Config/bootstrap.php:, _(*18)

CakePlugin::load(array('Markdown' => array('bootstrap' => true)));

Usage

Enable the helper using the plugin syntax, _(*19)

If desired, set the component to assist with the return of data from the markdown., _(*20)

// in app/Controller/BakeriesController.php
class BakeriesController extends AppController {

        public $helpers = array('Markdown.Markdown');

        public function index() {
            $this->set('textInMarkdownFormat', $yourTextInMarkdownFormat);
        }
}

Or, if the markdown content is in a file..., _(*21)

// in app/Controller/BakeriesController.php
class BakeriesController extends AppController {

        public $helpers = array('Markdown.Markdown');
        public $components = array('Markdown.Markdown');

        public function index() {
            $this->set('textInMarkdownFormat', $this->Markdown->getFile($pathToMarkdownFile));
        }
}

In the view you can use something like:, _(*22)

// in app/View/Bakeries/index.ctp
echo $this->Markdown->transform($textInMarkdownFormat);

In the model you can use something like:, _(*23)

```php // in app/Model/Bakery.php class BakeryModel extends AppModel {, <sub>(*24)</sub>

public $actsAs = array('Markdown.Markdown');

public function beforeSave($options = array()) {
    $this->data[$this->alias]['text_html'] = $this->transform( $this->data[$this->alias]['text_md'] );
    return true;
}

}, <sub>(*25)</sub>