Intellivoid
/
MarkdownParser
mirror of https://git.netkas.me/intellivoid/MarkdownParser.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

improve readme

This commit is contained in:
Emanuil Rusev 2017-10-22 16:00:43 +03:00 committed by GitHub
parent 07c937583d
commit 16aadff2ed
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -21,8 +21,6 @@ Better Markdown Parser in PHP
* Tested in 5.3 to 7.1 and in HHVM
* [Markdown Extra extension](https://github.com/erusev/parsedown-extra)
Note that when you deal with untrusted content (ex: user commnets) you should also use a HTML sanitizer like [HTML Purifier](http://htmlpurifier.org/).
### Installation
Include `Parsedown.php` or install [the composer package](https://packagist.org/packages/erusev/parsedown).
@ -37,6 +35,10 @@ echo $Parsedown->text('Hello _Parsedown_!'); # prints: <p>Hello <em>Parsedown</e
More examples in [the wiki](https://github.com/erusev/parsedown/wiki/) and in [this video tutorial](http://youtu.be/wYZBY8DEikI).
### Security
Parsedownw does not sanitize the outut HTML. When you deal with untrusted content (ex: user commnets) you should also use a HTML sanitizer like [HTML Purifier](http://htmlpurifier.org/).
### Questions
**How does Parsedown work?**