andreasindal/laravel-markdown

Simple Blade directive for markdown parsing.

⚠️ Important

This project is no longer maintained, will not received any updates and will not support future versions of Laravel., _(*1)

Laravel-Markdown

, _(*2)

A small, lightweight and easy-to-use Laravel package for handling markdown. It comes with a facade, a helper function and a Blade directive to make life easier for you., _(*3)

Installation

To install it, simply pull it down with Composer. Run the php artisan vendor:publish command to publish the configuration file., _(*4)

composer require andreasindal/laravel-markdown:"3.0.1"

Laravel 5.5 and above use Package Auto-Discovery, so you do not have to manually add the MarkdownServiceProvider., _(*5)

Usage

Blade-directive

The markdown parser may be used in your Blade templates by using the @markdown directive., _(*6)

<article>
    <h1>{{ $post->title }}</h1>

    <section class="content">
        @markdown($post->body)
    </section>
</article>

You can also use a block-style syntax:, _(*7)

@markdown
# Hello world

This *text* will be **parsed** to [HTML](http://laravel.com).
@endmarkdown

Facade

If you registered the Markdown facade as shown above, you can easily parse markdown using it., _(*8)

$markdown = "# Hello";

$html = Markdown::parse($markdown) // 

Hello

Helper-functions

$html = markdown('# Hello'); // <h1>Hello</h1>

$html = markdown_capture(function () {
    echo "# Hello";
    echo "\n\n";
    echo "So **cool**!"
});

// 

Hello


// 

So cool!, (*9)

Of course, you could also resolve the parser from the service container and use it yourself., _(*10)

$parser = app('Indal\Markdown\Parser');
$html = $parser->parse('# Hello'); // 

Hello

Drivers (NEW!)

Laravel-Markdown allows you to add custom markdown drivers. In order to use a custom markdown driver, you need to create a class that implements the Indal\Markdown\Drivers\MarkdownDriver interface. The interface contains two methods: text and line. text is used to convert a block of markdown to HTML, while line is used to convert a single line., _(*11)

Laravel-Markdown ships with a ParsedownDriver using the Parsedown-package by @erusev., _(*12)

Credits

• Mohamed Said (@themsaid)

License

Licensed under MIT. For more information, see the LICENSE-file., _(*13)