ccoley/laravel-markdown

A Parsedown wrapper for Laravel 5

v1.0.0 2015-08-16 06:34 UTC

This package is auto-updated.

Last update: 2024-11-09 15:34:17 UTC


README

A Parsedown wrapper for Laravel to compile markdown to HTML.

Parsedown is fast and supports GitHub flavored markdown.

The Markdown service provider included in this package uses deferred loading, meaning that it is not loaded with every request, and is instead loaded when you first use it.

Installation

Require this package with composer using the following command:

composer require ccoley/laravel-markdown

After updating composer, add the service provider to the providers array in config/app.php

Coley\Markdown\MarkdownServiceProvider::class,

If you want to use the Markdown facade, you need to add it to the aliases array in config/app.php

'Markdown' => Coley\Markdown\MarkdownFacade::class

Example

// Regular parsing.
// Output: <p>Hello <em>Markdown</em>!</p>
echo Markdown::text('Hello _Markdown_!');

// Parse only inline elements.
// Output: Hello <em>Markdown</em>!
echo Markdown::line('Hello _Markdown_!');

For more examples, or to see Parsedown configuration options, checkout the Parsedown wiki.