parsedown/README.md

32 lines
794 B
Markdown
Raw Normal View History

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