breeswish/php-marked

A PHP markdown parser, ported from marked. Built for speed.

php-marked - Yet Another PHP Markdown Parser

A full-featured PHP markdown parser., _(*1)

• Ported from chjj/marked, consistent with previewing by JavaScript, _(*2)

• Support Github Flavoured Markdown, _(*3)

  • Multiple underscores in words, _(*4)

  • URL autolinking, _(*5)

  • Strikethrough, _(*6)

  • Fenced code blocks, _(*7)

  • Tables, _(*8)

• High performance, _(*9)

Requirements

• PHP 5.3+, _(*10)

• Composer, _(*11)

Installation

composer require "breeswish/php-marked"

Usage

Minimal usage:, _(*12)

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

Example setting options with default values:, _(*13)

\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, _(*14)

String of markdown source to be compiled., _(*15)

options

Type: array, _(*16)

Hash of options. Can also be set using the Marked::setOptions method as seen above., _(*17)

Basic Options

gfm

Type: boolean Default: true, _(*18)

Enable GitHub flavored markdown., _(*19)

tables

Type: boolean Default: true, _(*20)

Enable GFM tables. This option requires the gfm option to be true., _(*21)

breaks

Type: boolean Default: false, _(*22)

Enable GFM line breaks. This option requires the gfm option to be true., _(*23)

pedantic

Type: boolean Default: false, _(*24)

Conform to obscure parts of markdown.pl as much as possible. Don't fix any of the original markdown bugs or poor behavior., _(*25)

sanitize

Type: boolean Default: false, _(*26)

Sanitize the output. Ignore any HTML that has been input., _(*27)

smartLists

Type: boolean Default: true, _(*28)

Use smarter list behavior than the original markdown. May eventually be default with the old behavior moved into pedantic., _(*29)

smartypants

Type: boolean Default: false, _(*30)

Use "smart" typograhic punctuation for things like quotes and dashes., _(*31)

langPrefix

Type: string Default: "lang-", _(*32)

The prefix to be append in the className of <code>., _(*33)

xhtml

Type: boolean Default: false, _(*34)

Render XHTML., _(*35)

headerPrefix

Type: string Default: "", _(*36)

The prefix to be append in the id attribute of headers., _(*37)

Testing

run phpunit., _(*38)

License

The MIT License., _(*39)