Skip to content

Commit

Permalink
Merge pull request #6 from robbieaverill/bugfix/phpmarkdown-readme-re…
Browse files Browse the repository at this point in the history
…ference

PHPMarkdownMarkdownRenderer readme fix
  • Loading branch information
UndefinedOffset committed Feb 17, 2016
2 parents 0da156c + 0fbd50a commit 46a93e5
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,10 +68,9 @@ GithubMarkdownRenderer::setUseGFM(true); //whether or not to use Github Flavoure
```

####PHPMarkdownMarkdownRenderer
PHPMarkdownMarkdownRenderer is simple and has no options. Use this to avoid the delay on page load the first time after editing that comes from using the Github renderer (especially if the page has many sections of markdown). You will need to install [PHP Markdown](https://github.com/michelf/php-markdown) for this to work.
PHPMarkdownMarkdownRenderer is simple and has no options. Use this to avoid the delay on page load the first time after editing that comes from using the Github renderer (especially if the page has many sections of markdown). You will need to install [PHP Markdown](https://github.com/michelf/php-markdown) for this to work - it can be installed with composer.

**Note:** This renderer does not support Github Flavoured Markdown.
```php
$renderer=new PHPMarkdownMarkdownRenderer();
Markdown::setRenderer($renderer);
```
Markdown::setRenderer('PHPMarkdownMarkdownRenderer');
```

0 comments on commit 46a93e5

Please sign in to comment.