parsedown-extra-laravel

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

parsedown-extra-laravel

★ 27 Open GitHub ↗

A Parsedown Extra package for Laravel and Lumen

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

### About

A [Parsedown Extra](https://github.com/erusev/parsedown-extra) package for Laravel.

[HTML Purifier](https://github.com/ezyang/htmlpurifier) is also used to filter the HTML output, protecting your application for insecure content. Additionally, [HTML5 Definitions for HTML Purifier](https://github.com/xemlock/htmlpurifier-html5) is used to add new definitions and sanitization for HTML5.

[![Build Status](https://img.shields.io/github/actions/workflow/status/AlfredoRamos/parsedown-extra-laravel/ci.yml?style=flat-square)](https://github.com/AlfredoRamos/parsedown-extra-laravel/actions)
[![Latest Stable Version](https://img.shields.io/packagist/v/alfredo-ramos/parsedown-extra-laravel.svg?style=flat-square&label=stable)](https://packagist.org/packages/alfredo-ramos/parsedown-extra-laravel)
[![Code Quality](https://img.shields.io/codacy/grade/56dd8413204e4b1ba3a715cc57bd8fee.svg?style=flat-square)](https://app.codacy.com/manual/AlfredoRamos/parsedown-extra-laravel/dashboard)
[![License](https://img.shields.io/packagist/l/alfredo-ramos/parsedown-extra-laravel.svg?style=flat-square)](https://raw.githubusercontent.com/AlfredoRamos/parsedown-extra-laravel/main/LICENSE)

### Compatibility

| Version | Laravel | Lumen | Status |
| :-----: | :---------------: | :---------------: | :------------: |
| 0.8.x | >= 5.5.x, < 6.x.x | >= 5.5.x, < 6.x.x | End of life |
| 1.x.x | 6.x.x | 6.x.x | End of life |
| 2.x.x | 7.x.x | 7.x.x | End of life |
| 3.x.x | 8.x.x | 8.x.x | End of life |
| 4.x.x | 9.x.x | 9.x.x | End of life |
| 5.x.x | 10.x.x | 10.x.x | End of life |
| 6.x.x | 11.x.x | 11.x.x | Active support |
| 7.x.x | 12.x.x | N/A | Active support |

### Installation

Run the following command on your terminal:

```shell
composer require 'alfredo-ramos/parsedown-extra-laravel:^7.0.0'
```

#### Laravel

Service providers and aliases will be registered automatically since Laravel `5.5.x`, thanks to the new package auto-discovery.

#### Lumen

Support for Lumen has been dropped since version `7.x.x`. If you need this package for Lumen up to version `11.x.x`, please install the previous major version [`6.0.0`](https://github.com/AlfredoRamos/parsedown-extra-laravel/tree/6.0.0)

### Usage

The `Markdown::parse()` method is responsible to transform the Markdown syntax into HTML, its signature is the following:

```php
Markdown::parse(string $text = '', array $config = [])
```

| Parameter |     Data type     | Default value | Required | Description                           |
| :-------: | :---------------: | :-----------: | :------: | :------------------------------------ |
|  `$text`  |     `string`      |     `''`      |   Yes    | Markdown text                         |
| `$config` | `array`, `string` |     `[]`      |    No    | Extra configuration for HTML Purifier |

**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**

```php
Markdown::parse('Hello world', ['config' => 'comments'])
```

Where `comments` is the key of the array `settings`.

```php
return [
	'purifier'	=> [
		'enabled'	=> true,
		'settings'	=> [
			'default' => [...],
			'comments' => [...]
		]
	]
];
```

**Using `$config` as an array**

```php
Markdown::parse('[DuckDuckGo](https://duckduckgo.com/)', ['config' => [
	'URI.Host' => 'localhost',
	'URI.DisableExternal' => true
]])
```

For all configuration options see the official [HTML Purifier config docs](http://htmlpurifier.org/live/configdoc/plain.html).

**Using default settings**

```php
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:

```php
{!! Markdown::parse("Hello world") !!}
{!! Markdown::parse("[XSS link](javascript:alert('xss'))") !!}
```

The code above will print:

```html
Hello world

<a>XSS link</a>

<a href="javascript:alert('xss')">XSS link</a>
```

#### Helper

For your convenience, the `markdown()` helper function is also available. It accepts the same parameters as the facade.

```php
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:

```shell
php artisan vendor:publish \
	--provider='AlfredoRamos\ParsedownExtra\ParsedownExtraServiceProvider' \
	--tag=config --force
```

parsedown-extra-laravel

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README