Markdown Is A CommonMark Wrapper For Laravel 5

Installs: 36 575

Dependents: 8

Stars: 184

Watchers: 9

Forks: 22

Open Issues: 1

Language: PHP

v4.0.0 2015-07-25 14:48 UTC

README

Laravel Markdown was created by, and is maintained by Graham Campbell, and is a CommonMark wrapper for Laravel 5. It ships with integration with Laravel's view system too. Feel free to check out the change log, releases, license, and contribution guidelines.

Laravel Markdown

Build Status Coverage Status Quality Score Software License Latest Version

Installation

PHP 5.5+ or HHVM 3.6+, and Composer are required.

To get the latest version of Laravel Markdown, simply add the following line to the require block of your composer.json file:

"graham-campbell/markdown": "~4.0"

You'll then need to run composer install or composer update to download it and have the autoloader updated.

Once Laravel Markdown is installed, you need to register the service provider. Open up config/app.php and add the following to the providers key.

  • 'GrahamCampbell\Markdown\MarkdownServiceProvider'

You can register the Markdown facade in the aliases key of your config/app.php file if you like.

  • 'Markdown' => 'GrahamCampbell\Markdown\Facades\Markdown'

Configuration

Laravel Markdown supports optional configuration.

To get started, you'll need to publish all vendor assets:

$ php artisan vendor:publish

This will create a config/markdown.php file in your app that you can modify to set your configuration. Also, make sure you check for changes to the original config file in this package between releases.

There is one config options:

Enable View Integration

This option ('views') specifies if the view integration is enabled so you can write markdown views and have them rendered as html. The following extensions are currently supported: '.md', '.md.php', and '.md.blade.php'. You may disable this integration if it is conflicting with another package. The default value for this setting is true.

Usage

Facades\Markdown

This facade will dynamically pass static method calls to the 'markdown' object in the ioc container which by default is an instance of League\CommonMark\Converter.

MarkdownServiceProvider

This class contains no public methods of interest. This class should be added to the providers array in config/app.php. This class will setup ioc bindings.

Further Information

There are other classes in this package that are not documented here (such as the engine and compiler classes). This is because they are not intended for public use and are used internally by this package.

License

Laravel Markdown is licensed under The MIT License (MIT).