README.md in jekyll-assets-2.0.3 vs README.md in jekyll-assets-2.1.0
- old
+ new
@@ -1,12 +1,12 @@
[][travis]
-[][coveralls]
+[][coverage]
[][code-climate] [][gemnasium]
[gemnasium]: https://gemnasium.com/jekyll/jekyll-assets
[code-climate]: https://codeclimate.com/github/jekyll/jekyll-assets
-[coveralls]: https://coveralls.io/r/jekyll/jekyll-assets
+[coverage]: https://codeclimate.com/github/jekyll/jekyll-assets/coverage
[travis]: https://travis-ci.org/jekyll/jekyll-assets
# Jekyll 3 Assets
Jekyll 3 assets is an asset pipeline using Sprockets 3 to build especially
@@ -55,14 +55,20 @@
- _assets/stylesheets
- _assets/fonts
- _assets/img
- _assets/js
features:
- automatic_image_size: true | false | default: true
- automatic_image_alt : true | false | default: true
+ automatic_img_size: true | false | default: true
+ automatic_img_alt : true | false | default: true
```
+### Cache Folder
+
+If you plan to change the `cache` folder, please make sure to add that
+folder to your `exclude` list in Jekyll or you will generate over and over
+and over again, `.` folders are not ignored by default.
+
### Sources
The listed resources in the example are all defaults. It should be noted
that we append your sources instead of replace our resources with yours. So
if you add "_assets/folder" then we will append that to our sources and
@@ -75,18 +81,20 @@
### Digesting
* Disable digesting by default in development.
* Digest by default in production
+***You can force digesting with `digest: true` in your `_config.yml`***
+
### Compression
* Requires sass and uglify.
* Disable compression by default in development.
* Enable by default in production.
-### Bower (web components support.)
+### Bower Components
Modify your `.bowerrc` file and add:
```javascript
{
@@ -96,11 +104,13 @@
And then add `_assets/bower` to your sources list and Sprockets will do the
the rest for you... you can even `//= require bower_asset.js`. We will even
compress them for you per normal if Sprockets supports it and allows us to.
-***You can force digesting with `digest: true` in your `_config.yml`***
+***You do not need to modify your `.bowerrc` file, you can optionally just
+add it to your sources list and it will work that way too! As long as it's in
+your Jekyll folder.***
## Tags
* image, img
* javascript, js
@@ -134,20 +144,36 @@
### Current Proxies:
* `sprockets:accept:<value>`
* `sprockets:write_to:<value>`
-## Liquid Variables in Arguments
+## Liquid Variables
-You can use Liquid variables inside of your arguments, but you must quote
-them to get them to work, this can be a partial argument quote a full argument
-quote or otherwise, it just must be quoted or escaped.
+We support liquid arguments for tag values (but not tag keys), and we also
+support Liquid pre-processing (with your Jekyll context) sass/less/css files
+you need do nothing special for the preprocessing an entire file, it's
+always done.
+An example of using Liquid in your tags:
+
```liquid
{% img '{{ image_path }}' %}
{% img '{{ image_path }}' proxy:key:'{{ value }}' %}
{% img {{\ image_path\ }} %}
```
+
+An example of using Liquid in your SCSS:
+
+```scss
+.bg {
+ background: url(asset_path("{{ site.background_image }}"));
+}
+```
+
+You have full access to your entire Jekyll context from any liquid
+processing we do, so you can do whatever you like and be as dynamic as you
+like, including full loops and conditional Liquid based CSS since we
+pre-process your text files.
## Getting a list of your assets and basic info from Liquid
We provide all *your* assets as a hash of Liquid Drops so you can get basic
info that we wish you to have access to without having to prepare the class.