johnny13/li3_markdown

Lithium PHP Markdown parser

0.1.0 2013-04-10 20:18 UTC

Requires

• php: >=5.3
• composer/installers: *

Suggests

• UnionOfRAD/lithium: Lithium is required for this plugin.

Replaces

• joseym/li3_markdown: *

BSD-3-Clause

• d1rk

• template
• markdown
• lithium
• li3

README

I forked this library in order to add better lithium support. Making a public version of the helper will allow you to also call this same functionality in your controller files.

Lithium library for parsing markdown, uses PHP Markdown Extra Extended.

PHP Markdown Extra version: 1.2.4

Installation

Use Composer

Best Option

Modify your projects composer.json file

{
    "require": {
    	...
        "johnny13/li3_markdown": "master"
        ...
    }
}

Run php composer.phar install (or php composer.phar update) and, aside from adding it to your Libraries, you should be good to go.

Submodule or Clone

Select one of the following

Clone/Download the plugin into your app's libraries directory.

Submodule

From your app directory:

git submodule add git://github.com/johnny13/li3_markdown.git libraries/li3_markdown

Clone

From your app/libraries directory:

git clone git://github.com/johnny13/li3_markdown.git

Usage:

To enable the library add the following line at the end of app/config/bootstrap/libraries.php:

Libraries::add('li3_markdown');

Controller Files

You can easily process text in any controller file like so:

 //Include the helper in your controller
 use li3_markdown\extensions\helper\Markdown;
 
 ...
 
 //Later in your function turn raw text to markdown
 $beauty = Markdown::rendermarkdown($rawtext);

Markdown Views

To parse an entire view with markdown simply name your template something similar to:

view_name.md.php

the renderer will see that it's a markdown template and render it, otherwise it will render it like normal.

Selective Rendering

This is a helper method that allows you to selectively render text thru the markdown parser. To render the result within a template file simply call the markdown helper and run display:

<?php echo $this->markdown->render($markup) ?>

Installation

Add a submodule to your li3 libraries:

git submodule add [e-mail]:johnny13/li3_markdown.git libraries/li3_markdown

and activate it in you app (config/bootstrap/libraries.php), of course:

Libraries::add('li3_markdown');

Collaborate

As always, I welcome your collaboration to make things "even more betterer", so fork and contribute if you feel the need.

Credits

• li3
• joseym/li3_markdown
• sandelius/li3_markdown

Please report any bug, here: https://github.com/johnny13/li3_markdown/issues