library laradown

buzzylab/laradown

A New Markdown parser for Laravel built on parsedown

Laradown

, _(*1)

A New Markdown parser for Laravel built on Parsedown and Parsedown Extra., _(*2)

Installation

The best and easiest way to install this package is through Composer., _(*3)

Compatibility

This package fully compatible with Laravel above 5.4., _(*4)

Require Package

Open your application's composer.json file and add the following line to the require array:, _(*5)

"buzzylab/laradown": "~0.2"

Note: Make sure that after the required changes your composer.json file is valid by running composer validate., _(*6)

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

Buzzylab\Laradown\MarkdownServiceProvider::class,

Note: Checkout Laravel's Service Providers and Service Container documentation for further details., _(*8)

And add the following to $aliases, _(*9)

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

Usage

<?php

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

That's all., _(*10)

Blade Directive:

Use @markdown directive with parameter:

@extends('layouts.master')

@section('content')



    
  {{-- $content is markdown data --}}
  @markdown($content)



@stop

Use @markdown with @endmarkdown as directive block:

@extends('layouts.master')

@section('content')



  @markdown
  
  # Laradown Packag
  
  @endmarkdown



@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, _(*11)

markdown_style()

Add style to converted html, _(*12)

License

This software is released under The MIT License (MIT)., _(*13)