jekyll-assets 1.0.0 → 2.0.0.pre.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 058024b6cab174fb532c02c4d3e08b7402c439c6
-  data.tar.gz: a6af4b2d17c61481cbcb005a7e68b7f6714d7ffb
+  metadata.gz: b9e0ba8666a5456c4cad0827a4d99fd850a68089
+  data.tar.gz: b60f463be255a335521d03e7202087833198b83e
 SHA512:
-  metadata.gz: 5868a43430640668b1656280ed95a683d0ab4289993b862502505171a2c77498b9f0989a3a6dd549c5b454fbed9b7d8c24b7226103a1af75f257325989890c9e
-  data.tar.gz: 1fbddde69c2034155c6cc7ed7efb7fc69e841825b7ad8eac1758bba63fcf64d55871b88cdeae712a774b897b548ed008131138173abfa229205a64e86265d955
+  metadata.gz: 3d2930e11fdb9669d239ed370ab22a5d04430961434cd29af23448e8643d839804e92dcb51c251a11478b3014468b2c3b964eef69f6b5c10ca572302614e55bc
+  data.tar.gz: b52a71fe9a67787b55987d8879af857a2eb99e6f733d468af6450931fcdb7a7780f2259cec160f72955b9036eb777ae4635816e95b51d309967dcffe65053ba0

data/Gemfile

@@ -1,16 +1,16 @@
 source "https://rubygems.org"
+gemspec
 
+gem "rake"
 group :development do
-  gem "rubocop", "~>0.29.1"
-  gem "rake"
-  gem "rspec"
-  gem "appraisal"
-
+  gem "pry"
+  gem "therubyracer", :platforms => :mri
   gem "guard-rspec"
-
-  gem "coveralls", :require => false
-  gem "simplecov", :require => false
+  gem "guard"
 end
 
-# Specify your gem's dependencies in jekyll-assets.gemspec
-gemspec
+gem "sprockets-es6", "~> 0.6"
+gem "autoprefixer-rails", "~> 6.0"
+gem "font-awesome-sass", "~> 4.4.0"
+gem "mini_magick", "~> 4.2"
+gem "uglifier"

data/LICENSE

@@ -1,22 +1,20 @@
 Copyright (c) 2012-2013 Aleksey V Zapparov (http://ixti.net/)
+Copyright (c) 2015 Jordon Bedwell (https://envygeeks.io)
 
-MIT License
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,598 +1,138 @@
-# Jekyll::Assets
+[![Build Status](https://travis-ci.org/jekyll-assets/jekyll-assets.png?branch=master)](https://travis-ci.org/jekyll-assets/jekyll-assets) [![Coverage Status](https://coveralls.io/repos/jekyll-assets/jekyll-assets/badge.png?branch=master)](https://coveralls.io/r/jekyll-assets/jekyll-assets) [![Code Climate](https://codeclimate.com/github/jekyll-assets/jekyll-assets/badges/gpa.svg)](https://codeclimate.com/github/jekyll-assets/jekyll-assets) [![Dependency Status](https://gemnasium.com/jekyll-assets/jekyll-assets.svg)](https://gemnasium.com/jekyll-assets/jekyll-assets)
 
-[![Gem Version](https://badge.fury.io/rb/jekyll-assets.svg)](http://badge.fury.io/rb/jekyll-assets)
-[![Build Status](https://travis-ci.org/jekyll-assets/jekyll-assets.svg?branch=master)](http://travis-ci.org/jekyll-assets/jekyll-assets)
-[![Dependency Status](https://gemnasium.com/jekyll-assets/jekyll-assets.svg)](https://gemnasium.com/jekyll-assets/jekyll-assets)
-[![Code Climate](https://codeclimate.com/github/jekyll-assets/jekyll-assets.svg)](https://codeclimate.com/github/jekyll-assets/jekyll-assets)
-[![Coverage Status](https://coveralls.io/repos/jekyll-assets/jekyll-assets/badge.svg?branch=master)](https://coveralls.io/r/jekyll-assets/jekyll-assets?branch=master)
 
-Jekyll plugin, that adds Rails-alike assets pipeline, that means that:
+## Are you looking for the docs for Jekyll Assets < 2.0.0?
 
-- It allows you to write javascript/css assets in other languages such as
-  CoffeeScript, Sass, Less and ERB.
-- It allows you to specify dependencies between your assets and automatically
-  concatenates them.
-- It allows you to minify/compress your JavaScript and CSS assets using
-  compressor you like: YUI, SASS, Uglifier or no compression at all.
-- It supports JavaScript templates for client-side rendering of strings or
-  markup. JavaScript templates have the special format extension `.jst` and are
-  compiled to JavaScript functions.
-- Adds MD5 fingerprint suffix for _cache busting_. That means your `app.css`
-  will become `app-908e25f4bf641868d8683022a5b62f54.css`. See `cachebust`
-  configuration option for other variants.
-- Produce gzipped versions of assets. See `gzip` configuration option for
-  details.
+See: https://github.com/jekyll-assets/jekyll-assets/tree/legacy#jekyllassets
 
-[compass]:      http://compass-style.org/
-[bourbon]:      http://bourbon.io/
-[neat]:         http://neat.bourbon.io/
-[autoprefixer]: https://github.com/postcss/autoprefixer
-[rails_assets]: https://rails-assets.org/
+# Jekyll 3 Assets
 
-Jekyll-Assets uses fabulous [Sprockets][sprockets] under the hood, so you may
-refer to Rails guide about [Asset Pipeline][rails-guide] for detailed
-information about amazing features it gives you.
+Jekyll 3 assets is an asset pipeline using Sprockets 3 to build especially
+for Jekyll 3.  It utilizes new features of both Sprockets and Jekyll to achieve
+a clean and extensible assets platform for Jekyll.
 
-*Note:* You must have an [ExecJS][extjs] supported runtime in order to use
-  CoffeeScript.
-
-
-[rails-guide]:  http://guides.rubyonrails.org/asset_pipeline.html
-[sprockets]:    https://github.com/sstephenson/sprockets#readme
-[extjs]:        https://github.com/sstephenson/execjs#readme
-
-For a quick start check out [jekyll-assets introduction][jekyll-assets-intro]
-that shows how to use it step by step. Also you might want to take a look on
-[my blog sources][ixti-blog-src] as a real-world example as well.
-
-[jekyll-assets-intro]:  http://ixti.net/software/2012/12/30/unleash-mr-hyde-introduction-of-jekyll-assets.html
-[ixti-blog-src]:        https://github.com/ixti/ixti.github.com
-
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'jekyll-assets'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install jekyll-assets
-
-
-## How to Use Jekyll-Assets
-
-First of all make sure to require it. Common practice is to add following line
-into `_plugins/ext.rb` file:
-
-``` ruby
-require "jekyll-assets"
-```
-
-Once plugin installed, you'll have following Liquid tags available:
-
-- `{% javascript app %}`: Generates `<script>` tag for `app.js`
-- `{% stylesheet app %}`: Generates `<link>` tag for `app.css`
-- `{% image logo.png %}`: Generates `<img>` tag for `logo.png`
-- `{% asset_path logo.png %}`: Returns _resulting_ URL for `logo.png`
-- `{% asset app.css %}`: Returns _compiled_ body of `app.css`
-
-You can pass extra attributes to `javascript`, `stylesheet` and `image` tags:
-
-``` html
-{% image logo.png alt="Logo" %}
-{% javascript app async %}
-{% stylesheet app actually="anything" you might='want' %}
-
-<!-- renders to something like this (linebreaks in tags for readability here) -->
-
-<img src="/assets/logo-68b329da9893e34099c7d8ad5cb9c940.png" alt="Logo">
-<script src="/assets/app-6b95b1b3231c52113ca34ae9d1b5dabf.js" async></script>
-<link rel="stylesheet" href="/assets/app-349212fba570137adfec745e37b6d7fb.css"
-      actually="anything" you might='want'>
-
-<!-- NOTICE !!! if your asset file contains spaces, surround it's name with quotes -->
-
-{% asset_path "my logo.png" %}
-{% asset_path 'my logo.png' %}
-```
-
-Also you'll have complimentary Liquid filters as well:
-
-- `{{ 'app' | javascript }}`: Generates `<script>` tag for `app.js`
-- `{{ 'app' | stylesheet }}`: Generates `<link>` tag for `app.css`
-- `{{ 'logo.png' | image }}`: Generates `<img>` tag for `logo.png`
-- `{{ 'logo.png' | asset_path }}`: Returns _resulting_ URL for `logo.png`
-- `{{ 'app.css' | asset }}`: Returns _compiled_ body of `app.css`
-
-Filters are used mostly to render tag (or asset source) using variable that
-holds value of asset logical path rather than specifiyng it directly. Here's
-an example that speaks for itself:
-
-```
-{% if page.custom_css %}{{ page.custom_css | stylesheet }}{% endif %}
-```
-
-All compiled assets will be stored under `assets/` dir of generated site.
-
-Pipeline assets should be under your sources directory of Jekyll site. When a
-file is referenced with liquid tag or with helper from another asset, Sprockets
-searches the three default asset locations for it: `_assets/images`,
-`_assets/javascripts` and `_assets/stylesheets`.
-
-For example these files:
-
-```
-_assets/stylesheets/app.css
-_assets/javascripts/app.js
-_assets/javascripts/vendor/jquery.js
-```
-
-would be referenced like this:
-
-``` html
-{% stylesheet app %}
-{% javascript app %}
-{% javascript vendor/jquery %}
-```
-
-You might want to require `vendor/jquery.js` into your `app.js`. To do so, just
-put following line in the beginning of your `app.js` to get it concatenated:
-
-``` javascript
-//= require vendor/jquery
-
-$(function () {
-  alert('I love BIG BOOKS!');
-});
-```
-
-If you want to use CoffeScript, just add `.coffee` suffix to the file you want
-and you're good to go. For example, here's how your `app.js.coffe` might look
-like:
-
-``` coffeescript
-#= require vendor/jquery
-
-$ ->
-  alert 'I love BIG BOOKS! And small ones too!'
-```
-
-Notice, that `vendor/jquery` is not required to be coffee script. You can easily
-mix CoffeeScript and vanilla JavaScript, CSS and SCSS and SASS and LESS. The
-difference is only in comments styles used with _directives_.
-
-See detailed information about these _directives_ below.
-
-You might also want your stylesheets and javascripts to be minified. In this
-case just install the `uglifier` gem and any other gems you will be using, e.g.
-`sass`, `coffee-script`. Then add following lines into your `config.yml`:
-
-``` yaml
-assets:
-  js_compressor:  uglifier
-  css_compressor: sass
-```
-
-If you want to use YUI compressor for minification, install `yui-compressor`
-gem and put `yui` in place of `uglifier` and/or `sass` in the config file.
-You can also define and use your own compressor, see "Custom Compressors".
-
-Let's go crazy now! Assume you want your blog's `body` background color to be
-white all the time, but red if you compiled your web-site in December. Just add
-`.erb` suffix extension and you can use ruby in your asset like this:
-
-```
-// file: _assets/stylesheets/app.css.sass.erb
-
-body
-  background-color: <%= (12 == Date.today.month) ? "red" : "white" %>
-```
-
-Want more? Sure, here you are. You can use JavaScript templating with EJS or ECO
-for example. Create a file `_assets/javascripts/hello.jst.ejs` with following
-contents:
-
-``` html
-<p>Hello, <span><%= name %></span>!</p>
-<p><%= info %></p>
-```
-
-Then use it in your `app.js` file like this:
-
-``` coffeescript
-#= require vendor/jquery
-#= require hello
-
-$ ->
-  $("body").html JST["hello"]
-    name: "ixti"
-    info: "I love BIG BOOKS! And small ones too!"
-```
-
-Finally, you might want to store your assets on [Amazon S3][amazon-s3] or any
-CDN service you like. As said previously, all compiled/processed assets got
-special MD5 checksum appended to their original filenames. So, for example,
-your `app.js.coffee` will become something like:
-
-    app-4f41243847da693a4f356c0486114bc6.js
-
-By default, generated URLs will have `/assets/` prefixes, but you will want to
-change this if you are going to host assets somewhere else. This can be easily
-changed via configuration:
+## Configuration
 
-``` yaml
+```yaml
 assets:
-  baseurl: http://my.super-cool-cdn.com/assets
-```
-
-[amazon-s3]: http://aws.amazon.com/s3
-
-
-### Images size (dimension) auto-guessing
-
-The image helper accepts options param (in square brackets) with `autosize`
-switch. If given, then image dimension will be calculated and
-apropriate attributes set:
-
-``` html
-{% image logo.png alt="Logo" [autosize] %}
-
-<!-- assuming logo.png is 50x50, the above will render -->
-
-<img src="/assets/logo-68b329da9893e34099c7d8ad5cb9c940.png" alt="Logo"
-     width="50" height="50">
+  cache: false | directory | default: .asset-cache
+  cdn: https://cdn.example.com
+  skip_prefix_with_cdn: false
+  prefix: "/assets"
+  assets:
+    - "*.png"
+    - "bundle.css"
+  digest: true
+  sources:
+    - "_assets/folder"
 ```
 
-You can also globally enable `autosize` in config (see `autosize` config option
-below). In this case, `image` tag will alway render dimension attributes unless
-you specify `no-autosize` switch. Assume you have `autosize` option enabled in
-config, then:
+## Asset Digesting
 
-``` html
-{% image logo.png [no-autosize] %}
-{% image logo.png %}
+* Disable digesting by default in development.
+* Digest by default in production
 
-<!-- assuming logo.png is 50x50, the above will render -->
+***You can force digesting with `digest: true` in your `_config.yml`***
 
-<img src="/assets/logo-68b329da9893e34099c7d8ad5cb9c940.png">
-<img src="/assets/logo-68b329da9893e34099c7d8ad5cb9c940.png"
-     width="50" height="50">
-```
+## ERB Support
 
-### Images resizing
+ERB Support is removed in favor of trying to get this included on Github Pages
+eventually (if I can.) Having ERB presents a security risk to Github because it
+would allow you to use Ruby in ways they don't want you to.
 
-The image helper accepts an option param with [resize:dimension] switch.
-If given the image will be resized to the appropriate dimensions.
+## Tags
 
-``` html
-{% image huge-logo.png [resize:50x50] %}
+* stylesheet, css, style
+* javascript, js
+* image, img
+* asset_path
 
-<!-- which will render something like: -->
-<img src="/assets/logo-50x50-68b329da9893e34099c7d8ad5cb9c940.png">
-```
+### Tag Example:
 
-You can also mix auto resizing with dimension guessing
-
-``` html
-{% image huge-logo.png [resize:50x50, autosize] %}
-
-<!-- Will be rendered like: -->
-<img src="/assets/logo-50x50-68b329da9893e34099c7d8ad5cb9c940.png" width="50" height="50">
+```liquid
+{% img src magick:2x alt:'This is my alt' %}
+{% img src magick:2x alt:'This is my alt' sprockets:accept:image/gif %}
 ```
 
-This feature requires imagemagick to be installed, and the dimension is any
-format that imagemagick understands: [Resize documentation][resize-doc].
-
-More examples:
-``` html
-{% image image.png [resize:400x400] %}  <!-- Fit whole image in these dimensions -->
-{% image image.png [resize:!300x150] %} <!-- Ignore aspect ratio -->
-{% image image.png [resize:200%] %}     <!-- Resize by percentage -->
-{% image image.png [resize:500@] %}     <!-- Resize to specific pixel count -->
-{% image image.png [resize:200x100^] %} <!-- Resize to fill area -->
-{% image image.png [resize:<200x10] %}  <!-- Only enlarge small image -->
-{% image image.png [resize:>200x10] %}  <!-- Only shrink large image -->
-```
+### What do the colons mean? Proxies/Tags
 
-[resize-doc]: http://www.imagemagick.org/Usage/resize/#resize
+* `argument` is a boolean HTML argument.
+* `key:value` is an HTML key="value" if no proxy exists.
+* `proxy:key:value` will set a proxy key with the given value.
+* `proxy:key` is a boolean argument if the proxy and key exists.
+* `unknown:key:value` will raise `DoubleColonError`, escape it.
+* `proxy:unknown:value` will raise a `UnknownProxyError`.
 
-### Custom Compressors
+Lets say we have `sprockets` proxies and sprockets allows you to proxy accept,
+if you send `{% img src sprockets:accept:image/gif }` then Sprockets find_asset
+will get `{ :accept => "image/gif" }` but if you try to proxy "unknown" on
+sprockets we will raise a Proxy error.  For more information then look at
+`parser_spec.rb` in the spec folder because it literally lays out the ground
+rules for our tags as a specification.
 
-Sprockets comes with good set of preconfigured compressors, but imagine you are
-not satisfied with default settings. For example you want to strip all comments
-but copyrights info. In this case you can define and use your own compressor.
+### Current Proxies:
 
-To do so, first let's define new compressor in `_plugins/ext.rb`:
+* `sprockets:accept:<value>` - Tell Sprockets your preferred content type.
+* `sprockets:write_to:<value>` - The filename you wish us to write your file to.
+* `magick:resize:<value>` - Takes standard ImageMagick resize values.
+* `magick:format:<value>` - Takes standard ImageMagick format values.
+* `magick:rotate:<value>` - Takes standard ImageMagick resize values.
+* `magick:crop:<value>` - Takes standard ImageMagick crop values.
+* `magick:flip:<value>` - Takes standard ImageMagick flip values.
+* `magick:2x` - Tells us to write a double width/height image.
+* `magick:4x` - Tells us to write a quadruple width/height image.
+* `magick:half` - Tells us to shrink the image to half.
 
-``` ruby
-require "jekyll-assets"
-require "sprockets"
-
-Sprockets.register_compressor 'application/javascript',
-  :my_uglifier, Uglifier.new(:comments => :copyright)
-```
+## Filters
 
-Once it's done, just tell assets to use `my_uglifier` as js compressor:
+There is a full suite of filters, actually, any tag and any proxy can be a
+filter by way of filter arguments, take the following example:
 
-``` yaml
-assets:
-  js_compressor: my_uglifier
+```liquid
+{{ src | img : "magick:2x" }}
 ```
 
+## Hooks
 
-### Compilation Cache
+* `:env => [
+    :pre_init, :post_init
+  ]`
 
-To improve build time, you can enabled compiled assets cache:
+You can register and trigger hooks like so:
 
-``` yaml
-assets:
-  cache: true
+```ruby
+Jekyll::Assets::Hook.trigger  :env, :post_init
+Jekyll::Assets::Hook.register :env, :post_init do
+  # Your Work
+end
 ```
 
-This will keep cache of compiled assets in `.jekyll-assets-cache` under source
-of your jekyl site. If you want to use different location specify it instead of
-`true`, in this case it should be an absolute path or path relative to source
-path of your jekyl site.
-
-
-## Custom Vendors
-
-Sometimes you would like to have some 3rd-party vendors. For this purposes,
-normally all you have to do is to override default assets sources in config:
-
-``` yaml
-assets:
-  sources:
-    - _assets/images
-    - _assets/javascripts
-    - _assets/stylesheets
-    - _vendors/bootstrap/stylesheets
-    - _vendors/bootstrap/javascripts
-```
-
-But sometimes this is not enough. For example, with compass. As jekyll-assets
-uses Sprockets internally, you can simply append "global" paths into it. Just
-add following line into your `_plugins/ext.rb` file:
-
-``` ruby
-require "sprockets"
-
-Sprockets.append_path "/my/vendor"
-```
-
-That's it, now jekyll-assets will try to look for assets inside `/my/vendor`
-path first.
-
-
-## The Directive Processor
-
-*Note:* This section extracted from [Sprockets][sprockets] README.
-
-Sprockets runs the *directive processor* on each CSS and JavaScript
-source file. The directive processor scans for comment lines beginning
-with `=` in comment blocks at the top of the file.
-
-    //= require jquery
-    //= require jquery-ui
-    //= require backbone
-    //= require_tree .
-
-The first word immediately following `=` specifies the directive
-name. Any words following the directive name are treated as
-arguments. Arguments may be placed in single or double quotes if they
-contain spaces, similar to commands in the Unix shell.
-
-**Note**: Non-directive comment lines will be preserved in the final
-  asset, but directive comments are stripped after
-  processing. Sprockets will not look for directives in comment blocks
-  that occur after the first line of code.
-
+## Optional Processing Engines
 
-### Supported Comment Types
+* ES6 Transpiler (through Babel) - add "sprockets-es6" to your Gemfile.
+* CSS Auto Prefixer - add "autoprefixer-rails" to your Gemfile.
 
-The directive processor understands comment blocks in three formats:
+***Please note that some of these (if not all) have trouble with Rhino --
+`therubyrhino` so you would probably be best to just use Node.js or io.js at
+that point rather than trying to fight it.***
 
-    /* Multi-line comment blocks (CSS, SCSS, JavaScript)
-     *= require foo
-     */
+### Engine Settings
 
-    // Single-line comment blocks (SCSS, JavaScript)
-    //= require foo
+Some engines take settings, if they do you can add them like so:
 
-    # Single-line comment blocks (CoffeeScript)
-    #= require foo
-
-
-### Sprockets Directives
-
-You can use the following directives to declare dependencies in asset
-source files.
-
-For directives that take a *path* argument, you may specify either a
-logical path or a relative path. Relative paths begin with `./` and
-reference files relative to the location of the current file.
-
-#### The `require` Directive
-
-`require` *path* inserts the contents of the asset source file
-specified by *path*. If the file is required multiple times, it will
-appear in the bundle only once.
-
-#### The `include` Directive
-
-`include` *path* works like `require`, but inserts the contents of the
-specified source file even if it has already been included or
-required.
-
-#### The `require_directory` Directive
-
-`require_directory` *path* requires all source files of the same
-format in the directory specified by *path*. Files are required in
-alphabetical order.
-
-#### The `require_tree` Directive
-
-`require_tree` *path* works like `require_directory`, but operates
-recursively to require all files in all subdirectories of the
-directory specified by *path*.
-
-#### The `require_self` Directive
-
-`require_self` tells Sprockets to insert the body of the current
-source file before any subsequent `require` or `include` directives.
-
-#### The `depend_on` Directive
-
-`depend_on` *path* declares a dependency on the given *path* without
-including it in the bundle. This is useful when you need to expire an
-asset's cache in response to a change in another file.
-
-#### The `stub` Directive
-
-`stub` *path* allows dependency to be excluded from the asset bundle.
-The *path* must be a valid asset and may or may not already be part
-of the bundle. Once stubbed, it is blacklisted and can't be brought
-back by any other `require`.
-
-
-## Configuration
-
-You can fine-tune configuration by editing your `_config.yml`:
-
-``` yaml
-#
-# Plugin: jekyll-assets
-#
+```YAML
 assets:
-  #
-  # Pathname of the destination of generated (bundled) assets relative
-  # to the destination of the root.
-  #
-  dirname: assets
-  #
-  # Base URL of assets paths.
-  #
-  baseurl: /assets/
-  #
-  # Pathnames where to find assets relative to the root of the site.
-  #
-  sources:
-    - _assets/javascripts
-    - _assets/stylesheets
-    - _assets/images
-  #
-  # Sets JS compressor. No compression by default.
-  # Possible variants: 'yui', 'uglifier', nil
-  #
-  js_compressor: ~
-  #
-  # Sets CSS compressor. No compression by default.
-  # Possible variants: 'yui', 'sass', nil
-  #
-  css_compressor: ~
-  #
-  # Globally enables adding image width and height attributes to image tags.
-  # Does nothing if either width or height attribute already set.
-  # Disabled by default.
-  #
-  autosize: false
-  #
-  # Sets cachebusting policy for generated assets.
-  #
-  # Possible variants:
-  #
-  #   none - disables cachebusting
-  #
-  #     source file:  _assets/javascripts/app.css
-  #     output file:  _site/assets/javascriptis/app.css
-  #     output URL:   /assets/javascripts/app.css
-  #
-  #   soft - leave filenames as-is, but `?cb=<md5>` suffix for URLs generated
-  #          with `asset_path`, `javascript` and `stylesheet`:
-  #
-  #     source file:  _assets/javascripts/app.css
-  #     output file:  _site/assets/javascriptis/app.css
-  #     output URL:   /assets/javascripts/app.css?cb=4f41243847da693a4f356c0486114bc6
-  #
-  #   hard - (default) injects cachebusting checksum into processed filename:
-  #
-  #     source file:  _assets/javascripts/app.css
-  #     output file:  _site/assets/javascriptis/app-4f41243847da693a4f356c0486114bc6.css
-  #     output URL:   /assets/javascripts/app-4f41243847da693a4f356c0486114bc6.css
-  #
-  cachebust: hard
-  #
-  # Whenever or not cache compiled assets (disabled by default).
-  # See `Compilation Cache` section of README for details.
-  #
-  cache: false
-  #
-  # Specifies list of MIME types that needs to have gzipped versions.
-  # You can set it to `false` to disable gzipping. Only javascripts and
-  # stylesheets are gzipped by default.
-  #
-  gzip: [ text/css, application/javascript ]
-  #
-  # Does not concatenates files requested by `javascript` and `stylesheet`
-  # helpers. Instead outputs multiple files in order they are required.
-  # Default: false
-  #
-  debug: false
-  #
-  # Configuration version. Used to force cache invalidation.
-  # Default: 1
-  #
-  version: 1
+  engines:
+    engine_name:
+      option: value
 ```
 
+Only whitelisted options are allowed by default, so that we can guard against
+using paths we don't want to be used.  If you wish to have an option
+whitelisted please file a ticket or submit a pull request.
 
-## "Th-th-th-that's all folks!"
-
-Feel free to follow me on [twitter][twitter], chat via [jabber][jabber] or
-write an [e-mail][e-mail]. :D
-
-[twitter]:  https://twitter.com/zapparov
-[jabber]:   xmpp://zapparov@jabber.ru
-[e-mail]:   mailto://ixti@member.fsf.org
-
-
-## Contributing
-
-* Fork [jekyll-assets][] on GitHub
-* Make your changes
-* Ensure all tests pass (`bundle exec rake`)
-* Send a pull request
-* If we like them we'll merge them
-* If we've accepted a patch, feel free to ask for commit access!
-
-[jekyll-assets]: https://github.com/ixti/jekyll-assets
-
-
-## License
-
-Copyright (C) 2012-2015 Aleksey V Zapparov
-
-The MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the “Software”), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
-of the Software, and to permit persons to whom the Software is furnished to do
-so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+## Plugins where did they go?
 
-THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+They're dead, in the way that they were, use Hooks, they require less
+patching and give more flexibility to us because we can trigger them every
+time we have a new environment not just occasionally.