alfredo-ramos / parsedown-extra-laravel
A Parsedown Extra package for Laravel and Lumen
Fund package maintenance!
www.paypal.me/IngAlfredoRamos/10.00USD
alfredoramos.mx/donate
Installs: 151 150
Dependents: 3
Suggesters: 0
Security: 0
Stars: 26
Watchers: 4
Forks: 0
Open Issues: 1
Type:package
Requires
- php: ^8.1.0
- erusev/parsedown-extra: ^0.8.1
- ezyang/htmlpurifier: ^4.16.0
- illuminate/config: ^10.0.0
- illuminate/filesystem: ^10.0.0
- illuminate/support: ^10.0.0
- xemlock/htmlpurifier-html5: ^0.1.11
Requires (Dev)
- mockery/mockery: ^1.5.0
- orchestra/testbench: ^8.0.0
- phpunit/phpunit: ^10.0.19
Suggests
- laravel/framework: To integrate with Laravel
- laravel/lumen-framework: To integrate with Lumen
This package is auto-updated.
Last update: 2024-10-18 04:20:39 UTC
README
About
A Parsedown Extra package for Laravel and Lumen.
HTML Purifier is also used to filter the HTML output, protecting your application for insecure content. Additionally, HTML5 Definitions for HTML Purifier is used to add new definitions and sanitization for HTML5.
Compatibility
Installation
Open your composer.json
file and add the package in the require
object:
"alfredo-ramos/parsedown-extra-laravel": "^5.0.0"
Then run composer update
on your terminal.
Laravel
Service providers and aliases will be registered automatically since Laravel 5.5.x
, thanks to the new package auto-discovery.
Lumen
In your bootstrap\app.php
file and register the service provider:
$app->register(AlfredoRamos\ParsedownExtra\ParsedownExtraServiceProvider::class);
Then register the facade alias:
$app->withFacades(true, [ AlfredoRamos\ParsedownExtra\Facades\ParsedownExtra::class => 'Markdown' ]);
Usage
The Markdown::parse()
method is responsible to transform the Markdown syntax into HTML, its signature is the following:
Markdown::parse(string $text = '', array $config = [])
Notes:
- If
$config
is a string, it will be trated as an array key in the[
purifier][
settings]
array. - If
$config
is an array it will extend default configuration for HTML Purifier. - An empty value for
$config
means that it will use default values for HTML Purifier, see\AlfredoRamos\ParsedownExtra\HTMLPurifierLaravel::getConfig()
for more information.
Using $config
as a string
Markdown::parse('Hello world', ['config' => 'comments'])
Where comments
is the key of the array settings
.
return [ 'purifier' => [ 'enabled' => true, 'settings' => [ 'default' => [...], 'comments' => [...] ] ] ];
Using $config
as an array
Markdown::parse('[DuckDuckGo](https://duckduckgo.com/)', ['config' => [ 'URI.Host' => 'localhost', 'URI.DisableExternal' => true ]])
For all configuration options see the official HTML Purifier config docs.
Using default settings
Markdown::parse('Hello world!') // Is the same as Markdown::parse('Hello world!', ['config' => 'default'])
Blade
It can be used in Blade through the Markdown
facade:
{!! Markdown::parse("Hello world") !!} {!! Markdown::parse("[XSS link](javascript:alert('xss'))") !!}
The code above will print:
<p>Hello world</p> <!-- HTML Purifier enabled --> <p><a>XSS link</a></p> <!-- HTML Purifier disabled --> <p><a href="javascript:alert('xss')">XSS link</a></p>
Helper
For your convenience, the markdown()
helper function is also available. It accepts the same parameters as the facade.
markdown('Hello world', ['purifier' => false])
Configuration
To add new or edit the default options, run the following command to make a copy of the default configuration file:
php artisan vendor:publish \
--provider='AlfredoRamos\ParsedownExtra\ParsedownExtraServiceProvider' \
--tag=config --force