mirror/parsedown
1
0
Fork 0
mirror of https://github.com/erusev/parsedown.git synced 2023-08-10 21:13:06 +03:00
Code Releases Activity

improve readme

Browse Source
This commit is contained in:
Emanuil 2013-07-23 23:32:45 +03:00
parent 69a620110a
commit 15f20fb59e
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -1,8 +1,25 @@
[Parsedown PHP](http://parsedown.org)
===
Parsedown is a parser for Markdown. It parses Markdown text the way people do. First, it divides texts into blocks. Then it looks at how these blocks start and how they relate to each other. Finally, it looks for special characters to identify inline elements. As a result, Parsedown is (super) fast, consistent and clean. Parsedown is a parser for Markdown. It parses Markdown text the way people do. First, it divides texts into blocks. Then it looks at how these blocks start and how they relate to each other. Finally, it looks for special characters to identify inline elements. As a result, Parsedown is (super) fast, consistent and clean.
[Explorer (demo)](http://parsedown.org/explorer/) [Explorer (demo)](http://parsedown.org/explorer/)
[Tests](http://parsedown.org/tests/) [Tests](http://parsedown.org/tests/)
### 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 <strong>Parsedown</strong>!</p>
```
--- ---
[![Coverage Status](https://coveralls.io/repos/erusev/parsedown/badge.png?branch=master)](https://coveralls.io/r/erusev/parsedown?branch=master) [![Coverage Status](https://coveralls.io/repos/erusev/parsedown/badge.png?branch=master)](https://coveralls.io/r/erusev/parsedown?branch=master)