MarkdownParser/README.md

32 lines
794 B
Markdown
Raw Normal View History

2013-11-16 08:51:01 +01:00
## Parsedown
2013-07-23 22:32:45 +02:00
2013-12-15 02:32:34 +01:00
Better [Markdown](http://en.wikipedia.org/wiki/Markdown) parser for PHP.
2013-07-10 22:22:16 +02:00
2013-11-23 14:58:58 +01:00
***
2013-12-15 02:32:34 +01:00
[ [demo](http://parsedown.org/demo) ] [ [tests](http://parsedown.org/tests/) ]
2013-11-23 14:58:58 +01:00
***
2013-12-03 21:49:50 +01:00
### Features
2013-11-23 14:58:58 +01:00
2013-11-30 23:10:30 +01:00
* [fast](http://parsedown.org/speed)
* [consistent](http://parsedown.org/consistency)
2013-12-03 22:19:50 +01:00
* [GitHub Flavored](https://help.github.com/articles/github-flavored-markdown)
2014-02-12 18:13:14 +01:00
* [tested](https://travis-ci.org/erusev/parsedown) in PHP 5.2, 5.3, 5.4, 5.5, 5.6 and [hhvm](http://www.hhvm.com/)
2014-01-21 22:15:02 +01:00
* friendly to international input
2013-07-23 09:36:28 +02:00
2013-07-23 22:32:45 +02:00
### Installation
Include `Parsedown.php` or install [the composer package](https://packagist.org/packages/erusev/parsedown).
### Example
2013-07-23 22:32:45 +02:00
```php
2014-01-21 22:15:02 +01:00
$text = 'Hello *Parsedown*!';
2013-07-23 22:32:45 +02:00
$result = Parsedown::instance()->parse($text);
2014-01-17 00:33:20 +01:00
echo $result; # prints: <p>Hello <em>Parsedown</em>!</p>
2013-11-13 00:38:29 +01:00
```