buzzylab / Laradown

Laradown

A New Markdown parser for Laravel built on Parsedown and Parsedown Extra.

Installation

The best and easiest way to install this package is through Composer.

Compatibility

This package fully compatible with Laravel above 5.4.

Require Package

Open your application's composer.json file and add the following line to the require array:

"buzzylab/laradown": "~0.2"

Note: Make sure that after the required changes your composer.json file is valid by running composer validate.

After installing the package, open your Laravel config file located at config/app.php and add the following service provider to the $providers array:

Buzzylab\Laradown\MarkdownServiceProvider::class,

Note: Checkout Laravel's Service Providers and Service Container documentation for further details.

And add the following to $aliases

'Markdown' => Buzzylab\Laradown\Facades\MarkdownFacade::class

Usage

<?php

echo Markdown::render(); // OR echo Markdown::convert();

That's all.

Blade Directive:

Use @markdown directive with parameter:

@extends('layouts.master')

@section('content')
<div>
    
  {{-- $content is markdown data --}}
  @markdown($content)
</div>
@stop

Use @markdown with @endmarkdown as directive block:

@extends('layouts.master')

@section('content')
<div>
  @markdown
  
  # Laradown Packag
  
  @endmarkdown
</div>
@stop

Add style to your converted html with @markdownstyle

    {{-- Get defaute style file --}}
    @markdownstyle
    
    {{-- Custom style file --}}
    @markdownstyle($file)

Helper Functions:

markdown($markdown)

Convert markdown content to html

markdown_style()

Add style to converted html

License

This software is released under The MIT License (MIT).