library/parsedown/README.md

   1 ## Parsedown
   2
   3 Better Markdown Parser in PHP
   4
   5 [[ demo ]](http://parsedown.org/demo)
   6
   7 ### Features
   8
   9 * [Fast](http://parsedown.org/speed)
  10 * [Consistent](http://parsedown.org/consistency)
  11 * [GitHub flavored](https://help.github.com/articles/github-flavored-markdown)
  12 * [Tested](http://parsedown.org/tests/) in PHP 5.2, 5.3, 5.4, 5.5, 5.6 and [hhvm](http://www.hhvm.com/)
  13 * [Extensible](https://github.com/erusev/parsedown/wiki/Writing-Extensions)
  14 * [Markdown Extra extension](https://github.com/erusev/parsedown-extra)
  15
  16 ### Installation
  17
  18 Include `Parsedown.php` or install [the composer package](https://packagist.org/packages/erusev/parsedown).
  19
  20 ### Example
  21
  22 ``` php
  23 $Parsedown = new Parsedown();
  24
  25 echo $Parsedown->text('Hello _Parsedown_!'); # prints: <p>Hello <em>Parsedown</em>!</p>
  26 ```
  27
  28 More examples in [the wiki](https://github.com/erusev/parsedown/wiki/Usage) and in [this video tutorial](http://youtu.be/wYZBY8DEikI).
  29
  30 ### Questions
  31
  32 **How does Parsedown work?**
  33
  34 It tries to read Markdown like a human. First, it looks at the lines. It’s interested in how the lines start. This helps it recognise blocks. It knows, for example, that if a line start with a `-` then it perhaps belong to a list. Once it recognises the blocks, it continues to the content. As it reads, it watches out for special characters. This helps it recognise inline elements (or inlines).
  35
  36 We call this approach "line based". We believe that Parsedown is the first Markdown parser to use it. Since the release of Parsedown, other developers have used the same approach to develop other Markdown parsers in PHP and in other languages.
  37
  38 **Is it compliant with CommonMark?**
  39
  40 It passes most of the CommonMark tests. Most of the tests that don't pass deal with cases that are quite uncommon. Still, as CommonMark matures, compliance should improve.
  41
  42 **Who uses it?**
  43
  44 [phpDocumentor](http://www.phpdoc.org/), [October CMS](http://octobercms.com/), [Bolt CMS](http://bolt.cm/), [Kirby CMS](http://getkirby.com/), [Grav CMS](http://getgrav.org/), [Statamic CMS](http://www.statamic.com/),  [RaspberryPi.org](http://www.raspberrypi.org/) and [more](https://www.versioneye.com/php/erusev:parsedown/references).
  45
  46 **How can I help?**
  47
  48 Use it, star it, share it and if you feel generous, [donate some money](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=528P3NZQMP8N2).