GitHub - gourmet/common-mark: CakePHP 3 support for CommonMark
Skip to content

gourmet/common-mark

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CommonMark

Build Status Total Downloads License

Adds CommonMark support to CakePHP 3 using the league/commonmark package.

What's included?

  • CommonMarkAwareTrait
  • CommonMarkHelper
  • CommonMarkBehavior coming soon

Install

Using Composer:

composer require gourmet/common-mark:~1.0

You then need to load the plugin. You can use the shell command:

bin/cake plugin load Gourmet/CommonMark

or by manually adding statement shown below to boostrap.php:

Plugin::load('Gourmet/CommonMark');

Usage

The plugin is basically a bridge disguised as a trait Gourmet\CommonMark\Utility\CommonMarkAwareTrait, so you could just use the trait from anywhere you wish.

To simplify it, both, a behavior and a helper have also been created.

// in any table's `initialize()`:
$this->addBehavior('Gourmet/CommonMark.CommonMark');

// in `App\View\AppView` or any view/controller for that matter:
$this->loadHelper('Gourmet/CommonMark.CommonMark');

For more, please check the tests and the league/commonmark library.

Patches & Features

  • Fork
  • Mod, fix
  • Test - this is important, so it's not unintentionally broken
  • Commit - do not mess with license, todo, version, etc. (if you do change any, bump them into commits of their own that I can ignore when I pull)
  • Pull request - bonus point for topic branches

Bugs & Feedback

http://github.com/gourmet/common-mark/issues

License

Copyright (c) 2015, Jad Bitar and licensed under The MIT License.

About

CakePHP 3 support for CommonMark

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages