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., (*1)
Lithium library for parsing markdown, uses PHP Markdown Extra Extended., (*2)
PHP Markdown Extra version: 1.2.4
, (*3)
Installation
Use Composer
Best Option, (*4)
Modify your projects composer.json
file, (*5)
~~~ json
{
"require": {
...
"johnny13/li3_markdown": "master"
...
}
}, (*6)
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
~~~, (*7)
the renderer will see that it's a markdown template and render it, otherwise it will render it like normal., (*8)
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
:, (*9)
<?php echo $this->markdown->render($markup) ?>
Installation
Add a submodule to your li3 libraries:, (*10)
git submodule add git@github.com:johnny13/li3_markdown.git libraries/li3_markdown
and activate it in you app (config/bootstrap/libraries.php), of course:, (*11)
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., (*12)
Credits
Please report any bug, here: https://github.com/johnny13/li3_markdown/issues, (*13)