andreasindal / laravel-markdown
Simple Blade directive for markdown parsing.
Installs: 223 799
Dependents: 7
Suggesters: 0
Security: 0
Stars: 186
Watchers: 2
Forks: 30
Open Issues: 3
Requires
- erusev/parsedown: ^1.6
- illuminate/support: >=5.5 < 6|^6
Requires (Dev)
- mockery/mockery: ^0.9.9
- phpunit/phpunit: ^6.0
README
⚠️ Important
This project is no longer maintained, will not received any updates and will not support future versions of Laravel.
Laravel-Markdown
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.
Laravel version | Laravel-Markdown version |
---|---|
5.8, 6.* | 3.1.1 |
5.7 | 3.0.1 |
5.6 | 3.0 |
5.5 | 2.0 |
5.3, 5.4 | 1.1 |
5.2 | 1.0 |
Installation
To install it, simply pull it down with Composer. Run the php artisan vendor:publish
command to publish the configuration file.
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.
Usage
Blade-directive
The markdown parser may be used in your Blade templates by using the @markdown
directive.
<article> <h1>{{ $post->title }}</h1> <section class="content"> @markdown($post->body) </section> </article>
You can also use a block-style syntax:
@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.
$markdown = "# Hello"; $html = Markdown::parse($markdown) // <h1>Hello</h1>
Helper-functions
$html = markdown('# Hello'); // <h1>Hello</h1>
$html = markdown_capture(function () { echo "# Hello"; echo "\n\n"; echo "So **cool**!" }); // <h1>Hello</h1> // <p>So <b>cool</b>!</p>
Of course, you could also resolve the parser from the service container and use it yourself.
$parser = app('Indal\Markdown\Parser'); $html = $parser->parse('# Hello'); // <h1>Hello</h1>
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.
Laravel-Markdown ships with a ParsedownDriver
using the Parsedown-package by @erusev.
Credits
- Mohamed Said (@themsaid)
License
Licensed under MIT. For more information, see the LICENSE-file.