README

A full-featured PHP markdown parser.

Ported from chjj/marked, consistent with previewing by JavaScript
Support Github Flavoured Markdown
- Multiple underscores in words
- URL autolinking
- Strikethrough
- Fenced code blocks
- Tables
High performance

Requirements

PHP 5.3+
Composer

Installation

composer require "breeswish/php-marked"

Usage

Minimal usage:

echo \Breezewish\Marked\Marked::render('I am using __markdown__.');
// => <p>I am using <strong>markdown</strong>.</p>

Example setting options with default values:

\Breezewish\Marked\Marked::setOptions(array(
    'gfm'          => true,
    'tables'       => true,
    'breaks'       => false,
    'pedantic'     => false,
    'sanitize'     => false,
    'smartLists'   => false,
    'smartypants'  => false,
    'langPrefix'   => 'lang-',
    'xhtml'        => false,
    'headerPrefix' => '',
    'highlight'    => null,
    'renderer'     => new \Breezewish\Marked\Renderer()
));

echo \Breezewish\Marked\Marked::render('I am using __markdown__.');

Marked::render(markdownString [,options])

markdownString

Type: string

String of markdown source to be compiled.

options

Type: array

Hash of options. Can also be set using the Marked::setOptions method as seen above.

Basic Options

gfm

Type: boolean Default: true

Enable GitHub flavored markdown.