bfrohs/markdown

This package is abandoned and no longer maintained. The author suggests using the league/commonmark package instead.

WIP: Markdown parser for PHP

dev-master 2013-10-31 17:05 UTC

Requires (Dev)

• phpunit/phpunit: 3.7.*

MIT

• Brandon Frohs

• markdown
• md

README

Important: This is an experiment and may be changed, rebased, or trashed at any point. Use extreme caution before using this code.

A few things to track:

• Core Syntax milestone

• GitHub Flavored Markdown milestone

Developer-friendly markdown parser for PHP.

Using

// If using composer, you're all set
// If not, add the following path to your PSR-0 autoloader: /path/to/markdown/psr-0
// Or include the class manually
// require_once('/path/to/markdown/src/app.php');

// Make `Markdown` an alias for `bfrohs\markdown\Markdown`
use bfrohs\markdown\Markdown;

// Create a new Markdown object with the scope of 'p'
$text = "Some string using *markdown*.";
$markdown = new Markdown($text);

// Convert provided markdown to HTML
$html = $markdown->toHTML();

echo $html; // <p>Some string using <em>markdown</em>.</p>

Differences from Dingus

• Inter-element whitespace is discarded

• Whitespace is collapsed into a single space

• Empty elements are output without trailing slash (ie, <br> instead of <br />)

• Currently no support for:

  • html <div>
  • entities "
  • autolinks <http://example.com/>
  • code blocks <?php
  • reference links [foo][]