montyclt / laravel-pug

Pug view adapter for Laravel

Laravel Pug

A small package that adds support for compiling Pug (Jade) templates to Laravel via Pug.php. Both vanilla php and Blade syntax is supported within the view.

Installation

1. Run composer require bkwld/laravel-pug
2. Add the service provider to your app.php providers: Bkwld\LaravelPug\ServiceProvider::class,

Configuration

All Pug.php config options are passed through via a Laravel config array.

• Laravel 4 : Publish the config file with php artisan config:publish bkwld/laravel-pug and edit at /app/config/packages/bkwld/laravel-pug/config.php
• Laravel 5 : Publish the config file with php artisan vendor:publish --provider="Bkwld\LaravelPug\ServiceProvider" and edit it at /config/laravel-pug.php.

Usage

Any file with the extension .pug will be compiled as a pug template. Laravel Pug also registers the .pug.php, .pug.blade, and .pug.blade.php as well as the .jade, .jade.php, .jade.blade, and .jade.blade.php extensions with Laravel and forwards compile requests on to Pug.php but we highly recommand you to use the clean and standard extension .pug that will be recognized by most systems. It compiles your Pug templates in the same way as Blade templates; the compiled template is put in your storage directory. Thus, you don't suffer compile times on every page load.

In other words, just put your Pug files in the regular views directory and name them like whatever.pug. You reference them in Laravel like normal:

• Laravel 4 : View::make('home.whatever') for app/views/home/whatever.pug
• Laravel 5 : view('home.whatever') for resources/views/home/whatever.pug

The Pug view files can work side-by-side with regular PHP views. To use Blade templating within your Pug, just name the files with .pug.blade or .pug.blade.php extensions. This feature is designed for transition purpose, since every blade features are available in pug, you would not need both.

Extending Layouts / Include Sub-views

Default root directory for templates is resources/views, so from any template any deep in the directory, you can use absolute paths to get other pug files from the root: extends /layouts/main will extends the file resources/views/layouts/main.(pug|jade), include /partial/foo/bar, will include resources/views/partial/foo/bar.(pug|jade). You can use the basedir option to set the root to an other directory. Paths that does not start with a slash will be resolved relatively to the current template file.

Histoy

Read the Github project releases for release notes.