jekyll-asset-pipeline 0.1.1 → 0.1.2

data/README.md

@@ -11,6 +11,7 @@
 - [Asset Compression](#asset-compression)
 - [Templates](#templates)
 - [Configuration](#configuration)
+- [Octopress](#octopress)
 - [Contribute](#contribute)
 - [Community](#community)
 - [Code Status](#code-status)
@@ -55,7 +56,7 @@ Jekyll Asset Pipeline is extremely easy to add to your Jekyll project and has no
 
 3. Move your assets into a Jekyll ignored folder (i.e. a folder that begins with an underscore "\_") so that Jekyll won't include these raw assets in the site output.  I recommend using an "\_assets" folder to hold your site's assets.
 
-4. Add the following [Liquid](http://liquidmarkup.org/) blocks to your site's HTML "head" section.  These blocks will be converted into HTML "link" and "script" tags that point to bundled assets.  Within each block is a manifest of assets to include in the bundle.  Assets are included in the same order that they are listed in the manifest.  Replace the "foo" and "bar" assets with your site's assets.  Name the bundle by including a string after the opening tag.  We've named our bundles "global" in the below example.
+4. Add the following [Liquid](http://liquidmarkup.org/) blocks to your site's HTML "head" section.  These blocks will be converted into HTML "link" and "script" tags that point to bundled assets.  Within each block is a manifest of assets to include in the bundle.  Assets are included in the same order that they are listed in the manifest.  Replace the "foo" and "bar" assets with your site's assets.  At this point we are just using plain old javascript and css files (hence the ".js" and ".css" extensions).  See the [Asset Preprocessing](#asset-preprocessing) section to learn how to include files that must be preprocessed (e.g. CoffeeScript, Sass, Less, Erb, etc.).  Name the bundle by including a string after the opening tag.  We've named our bundles "global" in the below example.
 
   ``` html
   {% css_asset_tag global %}
@@ -68,15 +69,15 @@ Jekyll Asset Pipeline is extremely easy to add to your Jekyll project and has no
   - /_assets/bar.js
   {% endjavascript_asset_tag %}
   ```
-  > *Asset manifests must be formatted as YAML arrays and include full paths to each asset from the root of the project.*
+  > *Asset manifests must be formatted as YAML arrays and include full paths to each asset from the root of the project.  YAML [does not allow tabbed markup](http://www.yaml.org/faq.html), so you must use spaces when indenting your YAML manifest or you will get an error when you compile your site.  If you are using assets that must be preprocessed, you should append the appropriate extension (e.g. '.js.coffee', '.css.less') as discussed in the [Asset Preprocessing](#asset-preprocessing) section.*
 
 5. Run the `jekyll` command to compile your site.  You should see an output that includes the following Jekyll Asset Pipeline status messages.
 
   ``` bash
   Asset Pipeline: Processing 'css_asset_tag' manifest 'global'
-  Asset Pipeline: Saved 'global-md5hash.css' to '_site/assets'
+  Asset Pipeline: Saved 'global-md5hash.css' to 'yoursitepath/assets'
   Asset Pipeline: Processing 'javascript_asset_tag' manifest 'global'
-  Asset Pipeline: Saved 'global-md5hash.js' to '_site/assets'
+  Asset Pipeline: Saved 'global-md5hash.js' to 'yoursitepath/assets'
   ```
 
   > *If you do not see these messages, check that you have __not__ set Jekyll's "safe" option to "true" in your site's "_config.yml".  If the "safe" option is set to "true", Jekyll will not run plugins.*
@@ -119,7 +120,9 @@ In the following example, we will add a preprocessor that converts CoffeeScript
 
   > *If you are using [Bundler](http://gembundler.com/) to manage your project's gems, you can just add "coffee-script" to your Gemfile and run `bundle install`.*
 
-3. Run the `jekyll` command to compile your site.
+3. Append a ".coffee" extension to the filename of any asset that should be converted with the `CoffeeScriptConverter`.  For example, "foo.js" would become "foo.js.coffee".
+
+4. Run the `jekyll` command to compile your site.
 
 That is it!  Your asset pipeline has converted any CoffeeScript assets into JavaScript before adding them to a bundle.
 
@@ -270,6 +273,22 @@ asset_pipeline:
 > - The "output\_path" setting defines where generated bundles should be saved within the "\_site" folder of your project.
 > - The "gzip" setting controls whether Jekyll Asset Pipeline saves gzipped versions of your assets alongside un-gzipped versions.
 
+## Octopress
+
+[Octopress](http://octopress.org/) is a popular framework for Jekyll that can help you get a blog up and running quickly.  Jekyll Asset Pipeline can be added to an Octopress site using the [Getting Started](#getting-started) steps above with the following modifications:
+
+1. Octopress uses Bundler to manage your site's dependencies.  You should add `gem "jekyll-asset-pipeline"` to your Gemfile and then run `bundle install` to install.
+
+2. Instead of adding a "\_plugins" folder, you should put "jekyll\_asset\_pipeline.rb" in the "plugins" folder included by default in the root of your Octopress site.
+
+3. You should still store your assets in an Jekyll ignored folder (i.e. a folder that begins with an underscore "\_"), but note that this folder should be located within the "source" folder of your Octopress site (e.g. "source/\_assets").
+
+4. No change to this step.
+
+5. Instead of running the `jekyll` command to compile your site, you should use Octopress' rake commands (e.g. `rake generate`) as outlined [here](http://octopress.org/docs/blogging/).
+
+If you have any difficulties using Jekyll Asset Pipeline with Octopress, please [open an issue](http://github.com/matthodan/jekyll-asset-pipeline/issues).
+
 ## Contribute
 
 You can contribute to the Jekyll Asset Pipeline by submitting a pull request [via GitHub](https://github.com/matthodan/jekyll-asset-pipeline).  I have identified the following areas for improvement:

data/lib/jekyll_asset_pipeline/extensions/liquid/liquid_block_extensions.rb

@@ -38,7 +38,7 @@ module JekyllAssetPipeline
 
         # Prevent Jekyll from cleaning up saved assets
         pipeline.assets.each do |asset|
-          puts "Asset Pipeline: Saved '#{asset.filename}' to '_site/#{asset.output_path}'"
+          puts "Asset Pipeline: Saved '#{asset.filename}' to '#{site.dest}/#{asset.output_path}'"
           site.static_files << JekyllAssetPipeline::StaticAssetFile.new(site, site.dest, asset.output_path, asset.filename)
         end
 

data/lib/jekyll_asset_pipeline/version.rb

@@ -1,3 +1,3 @@
 module JekyllAssetPipeline
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-asset-pipeline
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-15 00:00:00.000000000 Z
+date: 2012-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll