Checkout the master branch, installable by requiring "graham-campbell/markdown": "~3.0".
Laravel Markdown was created by, and is maintained by Graham Campbell, and is a Parsedown Extra wrapper for Laravel 4.1/4.2. It ships with integration with Laravel's view system too. Feel free to check out the change log, releases, license, api docs, and contribution guidelines.
PHP 5.4+ or HHVM 3.2+, and Composer are required.
To get the latest version of Laravel Markdown, simply require "graham-campbell/markdown": "~2.0" in your composer.json file. 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 app/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 app/config/app.php file if you like.
'Markdown' => 'GrahamCampbell\Markdown\Facades\Markdown'
Laravel Markdown supports optional configuration.
To get started, first publish the package config file:
$ php artisan config:publish graham-campbell/markdownThere is one config options:
This option ('engines') specifies if the view engines are enabled so you can write markdown views and have them compiled into html. The following extensions are currently supported: '.md', '.md.php', and '.md.blade.php'. You may disable the engines if they are conflicting with another package. The default value for this setting is true.
This is the class of most interest. It is bound to the ioc container as 'markdown' and can be accessed using the Facades\Markdown facade. There is one public method of interest.
The 'render' method will parse a string as markdown using Emanuil Rusev's Parsedown Extra package, and will return a string of html.
This facade will dynamically pass static method calls to the 'markdown' object in the ioc container which by default is the Markdown class.
This class contains no public methods of interest. This class should be added to the providers array in app/config/app.php. This class will setup ioc bindings.
There are other classes in this package that are not documented here (such as the engine classes). This is because they are not intended for public use and are used internally by this package.
Feel free to check out the API Documentation for Laravel Markdown.
You may see an example of implementation in Bootstrap CMS.
Apache License
Copyright 2013-2014 Graham Campbell
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.