Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jtgrimes/less4laravel

Bringing Less to Laravel
https://github.com/jtgrimes/less4laravel

Last synced: 14 days ago
JSON representation

Bringing Less to Laravel

Awesome Lists containing this project

README

        

Less4Laravel
============

Allows you to use [Less](http://lesscss.org//) in [Laravel 5](http://laravel.com/) with
no fuss, no muss.

----------
## If you're still using Laravel 4, please lock your composer version to `'~0.3'`. Check out the [README_L4.md](README_L4.md) file for more Laravel 4 instructions ##

----------

License
==========

Less4Laravel is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT), the same license Laravel uses.

Installation
============

Via Composer

````
$ composer require jtgrimes\less4laravel
````

Once Composer has installed or updated your packages, you need to register
Less4Laravel with Laravel itself. Open up `/config/app.php` and
find the providers key towards the bottom and add:

````
'Jtgrimes\Less4laravel\LessServiceProvider'
````

In the aliases section, add:

````
'Less' => 'Jtgrimes\Less4laravel\LessFacade'
````

Configuration
=============

In order to work with the configuration file, you're best off publishing a copy
with Artisan:

````
$ php artisan vendor:publish
````

The defaults are:

* Recompile whenever any .less file is updated.
* Cache .less files in `/storage/framework/cache`
* Store .less files in `resources/assets/less`
* Store generated .css files in `public/css`
* Link to `/css/filename.css`
* Don't minify the generated css file

All of these defaults can be changed in `/app/config/less4laravel.php`.

Additionally you can (and probably should) have different configurations for development
and production. Specifically, you probably don't want to be generating css files on
your production server, since it will slow down your site.

In order to have different configs on your development and production servers, you'll do something
like this:

Open up less4laravel.config and change

````
'compile_frequency' => 'changed',
````
to

````
'compile_frequency' => env('LESS4LARAVEL_FREQUENCY'),
````

You can use any environment variable name you want -- L4L_FREQ is an example.

In your local `.env` file, add
````
'LESS4LARAVEL_FREQUENCY' => 'changed',
````
and in your production `.env` file, add
````
'LESS4LARAVEL_FREQUENCY' => 'never'
````

Usage
=====

In your view file, just call `Less::to('file')` to compile the .less file (if needed) and generate a link to the output css file.

If you're using Laravel Blade, be sure to un-escape your call to Less:

````
{!! Less::to('file') !!}
````

To add properties to your link, just put them in an array as the second variable to the `to` function:
`Less::to('filename', ['media'=>'print'])` will
generate ``

You can also use the `Less::link()` function if you don't want Less4Laravel generating your html:

````

````

Credits
=======

Less4Laravel doesn't exist without Leaf Corcoran's [lessphp](http://leafo.net/lessphp/).
lessphp doesn't exist without [LESS](http://lesscss.org/).
Less4Laravel also requires Taylor Otwell's [Laravel](http://laravel.com/) framework.
The readme is largely boosted from Rob Crowe's readme for (the very awesome) [TwigBridge](https://github.com/rcrowe/TwigBridge).