Merge branch 'master' of github.com:lifo/docrails

This commit is contained in:
Ray Baxter 2011-07-17 09:31:23 -07:00
commit a4a309f2bc
2 changed files with 13 additions and 11 deletions

@ -326,33 +326,32 @@ TODO: Apache instructions
h3. Customizing The Pipeline
h4. CSS
There is currently one option for processing CSS - SCSS. This Gem extends the CSS syntax and offers minification.
h4. CSS Compression
The following line will enable SCSS in you project.
There is currently one option for compressing CSS - YUI. This Gem extends the CSS syntax and offers minification.
The following line will enable YUI compression, and requires the +yui-compressor+ gem.
<erb>
config.assets.css_compressor = :scss
config.assets.css_compressor = :yui
</erb>
This option is for compression only and does not relate to the SCSS language extensions that apply when using the +.scss+ file extension on CSS assets.
The +config.assets.compress+ must be set to +true+ to enable CSS compression
h4. Javascript
There are three options available to process javascript - uglifier, closure and yui.
Possible options for Javascript compression are +:closure+, +:uglifier+ and +:yui+. These require the use of the +closure-compiler+, +uglifier+ or +yui-compressor+ gems respectively.
The default Gemfile includes "uglifier":https://github.com/lautis/uglifier. This gem wraps "UglifierJS":https://github.com/mishoo/UglifyJS (written for NodeJS) in Ruby. It compress your code by removing white spaces and other magical things like changing your if and else statements to ternary operators when possible.
TODO: Add detail about the other two
The following line will invoke uglifier for Javascript compression.
<erb>
config.assets.js_compressor = :uglifier
</erb>
The +config.assets.compress+ must be set to +true+ to enable Javascript compression
h4. Using your own compressor
@ -418,3 +417,4 @@ h3. Making Your Library or Gem a Pre-Processor
"You should be able to register [your gems] on "Tilt":Tilt and Sprockets will find them." - Josh
[Tilt]https://github.com/rtomayko/tilt

@ -120,10 +120,12 @@ h4. Configuring Assets
Rails 3.1, by default, is set up to use the +sprockets+ gem to manage assets within an application. This gem concatenates and compresses assets in order to make serving them much less painful.
* +config.assets.css_compressor+ defines the CSS compressor to use. Only supported value at the moment is +:yui+, which uses the +yui-compressor+ gem.
* +config.assets.enabled+ a flag that controls whether the asset pipeline is enabled. It is explicitly initialized in +config/application.rb+.
* +config.assets.compress+ a flag that enables the compression of compiled assets. It is explicitly set to true in +config/production.rb+.
* +config.assets.css_compressor+ defines the CSS compressor to use. Only supported value at the moment is +:yui+, which uses the +yui-compressor+ gem.
* +config.assets.js_compressor+ defines the JavaScript compressor to use. Possible values are +:closure+, +:uglifier+ and +:yui+ which require the use of the +closure-compiler+, +uglifier+ or +yui-compressor+ gems respectively.
* +config.assets.paths+ contains the paths which are used to look for assets. Appending paths to this configuration option will cause those paths to be used in the search for assets.