From 4a5bef22dac5fe9fad58065006a231746d73689f Mon Sep 17 00:00:00 2001 From: Vipul A M Date: Fri, 29 Apr 2016 22:39:00 +0530 Subject: Document config.assets.gzip flag. Follow up of https://github.com/rails/sprockets-rails/pull/342. [ci skip] --- guides/source/asset_pipeline.md | 11 +++++++++++ guides/source/configuring.md | 2 ++ 2 files changed, 13 insertions(+) diff --git a/guides/source/asset_pipeline.md b/guides/source/asset_pipeline.md index cc3da47db9..bb04e5e94c 100644 --- a/guides/source/asset_pipeline.md +++ b/guides/source/asset_pipeline.md @@ -1111,6 +1111,17 @@ effect on the application. Instead, setting `config.assets.css_compressor` and `config.assets.js_compressor` will control compression of CSS and JavaScript assets. + +### Serving GZipped version of assets + +By default, gzipped version of compiled assets will be generated, along +with the non-gzipped version of assets. Gzipped assets help reduce, the transmission of +date over the wire. You can configure this by setting the `gzip` flag. + +```ruby +config.assets.gzip = false # disable gzipped assets generation +``` + ### Using Your Own Compressor The compressor config settings for CSS and JavaScript also take any object. diff --git a/guides/source/configuring.md b/guides/source/configuring.md index bb07bc2ca1..7ec55e8665 100644 --- a/guides/source/configuring.md +++ b/guides/source/configuring.md @@ -163,6 +163,8 @@ pipeline is enabled. It is set to true by default. * `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.gzip` a flag that enables the creation of gziped version of compiled assets, along with non-gziped assets. Set to `true` by default. + * `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. * `config.assets.precompile` allows you to specify additional assets (other than `application.css` and `application.js`) which are to be precompiled when `rake assets:precompile` is run. -- cgit v1.2.3