Download the PHP package tomakee/laravel-markdown-wrapper without Composer

laravel-markdown-wrapper

日本語ドキュメント

Simple Laravel wrapper class for markdown parser such as michelf/php-markdown or cebe/markdown, etc.

This package is just wrapper classes for Laravel, it won't parse markdown by itself, for that you need a actual parser. Add your favorite Markdown Parser.

Environment

• PHP >= 5.6
• Laravel >= 5.4
• Markdown Parser
  • michelf/php-markdown
  • cebe/markdown
  • etc.

Functions

• Blade directives: @markdown, @endmarkdown, @markdownFile.
• Laravel helpers: markdown(), markdown_config(), markdown_file(), markdown_capture().
• Laravel facade: Markdown::parse(), Markdown::setConfig(), Markdown::file(), Markdown::start(), Markdown::end()
• Wrapper class main: Tomakee\Markdown\Parser

Howto Install PHP Composer

You need to install php coomposer first if you don't have it in your system.

Howto Create Laravel Project

After install php composer, you need to create a Laravel project.
You can skip this step if you simply add it in your project.

Howto Install

After install Laravel, you can install this package with follow commands.

Add Laravel Service Provider into config/app.php.

And add your favorite Markdown Parser such as:

Blade Directives

You can create view mixed markdown and Blade.
For example:

single line

multiple line

include markdown file

Laravel Helpers

Anywhere Controller, etc., you can access to the wrapper class.

markdown()

markdown_config()

markdown_file()

markdown_capture()

Laravel Facade

In your Controller, etc., you can access to the wrapper class with Laravel Facade.

Import markdown facade

To use Laravel Facade, first, you need import Markdown Facade.
Class path:

Markdown::parse()

Markdown::file()

Markdown::setConfig()

Markdown::PARSER_METHOD()

It's accessable to the original parser method directly through to magic method:

Laravel App Container

It can access wrapper class instance from binded application container. See this php: src/MarkdownServiceProvider.php.

app('markdown'), app('Tomakee\Markdown\Parser')

app('markdown')->parse()

app('markdown')->file()

app('markdown')->setConfig()

app('markdown')->PARSER_METHOD()

It's accessable to the original parser method directly through to magic method:

Markdown Parser Config

Markdown wrapper class config is placed at after execute:

Example:

default

Automatically loading parser class id (see ).
(default value: 'michelf-extra')

resources

Markdown file resources path. Markdown files will be finded in this path. If they are placed in different pathes, then should be set all of pathes in this array().
(default value: [resource_path('views')])

extensions

Markdown file extensions array.
(default value: ['md', 'md.blade.php', 'blade.php', 'php'])

Parser settings

• id : Unique id string for the parser class. If it's unique, anything is possible.
• parser : Full path string of the parser class such as .
• methods : A single or multiple line to parse markdown method name. Array keys are "single" and "multi".
  • single : for single line markdown.
  • multi : for multipule line markdown.
• config : Parser class config properties array. If there is no config, value must be empty array().