Download the PHP package maxxscho/laravel-markdown-plus without Composer
On this page you can find all versions of the php package maxxscho/laravel-markdown-plus. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package laravel-markdown-plus
NOT MAINTAINED ANYMORE!!
Laravel Markdown-Plus
A simple Laravel 4 parser for markdown files with an optional meta-data section.
Installation
Laravel Markdown-Plus can be installed via composer by requiring the maxxscho/laravel-markdown-plus
package in your project's composer.json
.
Next add the service provider and the alias to app/config/app
.
Usage
Markdown file example
The meta section should be in YAML style, seperated by a custom splitter, which can be set in the config as a regular expression, default 3 or more dashes in an own line. Example:
Usage in Laravel
The meta data will be parsed with Symfony's Yaml Parser. After parsing the meta is an multidimensional array.
! Dates in the format YYYY-MM-DD
will be parsed into a timestamp.
Available methods
$document->getContent()
- returns the parsed Markdown (HTML-Content)
$document->getRawContent()
- returns the raw content (pure Markdown)
$document->getMeta()
- returns the whole meta data as an multidimensional array
$document->title()
- this is a magic method. The name of the method returns its equivalent meta. For example $document->cool-meta()
return the value of cool-meta: Cool Value
Configuration
Laravel-Markdown-Plus comes with some basic configuration.
Publish the configuration to customize the options:
php artisan config:publish maxxscho/laravel-markdown-plus
You'll find the config file in app/config/packages/maxxscho/laravel-markdown-plus
Available Config-Options
'use_meta' => true,
- whether you wanna use meta data or not
'section_splitter' => '/\s+-{3,}\s+/',
- the seciton splitter
'use_extra' => true,
- do you wanna parse markdown with additional features
'markdown_parser_options'
- options for the markdown parser itself. More infos
Licencse
This is free software distributed under the terms of the MIT license.
Additional information
Inspired by an based on Dayle Rees Kurenai.
This package uses:
All versions of laravel-markdown-plus with dependencies
illuminate/support Version 4.2.*
michelf/php-markdown Version 1.4.*
symfony/yaml Version 2.5.*