summaryrefslogtreecommitdiff
path: root/vendor/parsedown-0.9.0/README.md
blob: c87f7e11f30d79fa7c3f6b252e093afe9b50aff0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
## Parsedown

Better [Markdown](http://en.wikipedia.org/wiki/Markdown) parser for PHP.

***

[ [demo](http://parsedown.org/demo) ] [ [tests](http://parsedown.org/tests/) ]

***

### Features

* [fast](http://parsedown.org/speed)
* [consistent](http://parsedown.org/consistency)
* [GitHub Flavored](https://help.github.com/articles/github-flavored-markdown)
* [tested](https://travis-ci.org/erusev/parsedown) in PHP 5.2, 5.3, 5.4, 5.5 and [hhvm](http://www.hhvm.com/)
* friendly to international input

### Installation

Include `Parsedown.php` or install [the composer package](https://packagist.org/packages/erusev/parsedown).

### Example

```php
$text = 'Hello *Parsedown*!';

$result = Parsedown::instance()->parse($text);

echo $result; # prints: <p>Hello <em>Parsedown</em>!</p>
```