The master branch is the 4.x version of Middleman-Sprockets.
If you're just getting started, install the
middleman gem and generate a new project:
gem install middleman middleman init MY_PROJECT
gem "middleman-sprockets" to your
Gemfile and run
To activate the extension, in your
There are currently two options for configuration,
imported_asset_path [default: 'assets']
This is the path imported/linked assets will be added to the sitemap. For example, in the bower fixture app, the
//= link "lightbox2/img/close.png". This linked asset will be added to the sitemap at
To configure, in
activate :sprockets do |c| c.imported_asset_path = "YOUR_PATH" end
You can also pass an object (proc/lambda/class) that responds to
imported_asset_path to conditionally determine where assets go.
activate :sprockets do |c| c.imported_asset_path = ->(sprockets_asset) do if sprockets_asset.logical_path =~ /\.js$/ # all files ending with .js get put in /vendor-js File.join('vendor-js', sprockets_asset.logical_path) else # other assets head to /imported File.join('imported', sprockets_asset.logical_path) end end end
View the imported_asset_processor test for an example using a class.
expose_middleman_helpers [default: false]
Sometimes you might need sprockets to have access helpers (for example using different keys depending on deployment environment). Getting this to happen is bound to be full of edge cases, so for now it's behind a configuration option.
If you need Middleman helpers in your Sprockets, in
activate :sprockets do |c| c.expose_middleman_helpers = true end
Build & Dependency Status
The official community forum is available at: http://forum.middlemanapp.com
Github Issues are used for managing bug reports and feature requests. If you run into issues, please search the issues and submit new problems: https://github.com/middleman/middleman-sprockets/issues
The best way to get quick responses to your issues and swift fixes to your bugs is to submit detailed bug reports, include test cases and respond to developer questions in a timely manner. Even better, if you know Ruby, you can submit Pull Requests containing Cucumber Features which describe how your feature should work or exploit the bug you are submitting.
How to Run Cucumber Tests
- Checkout Repository:
git clone https://github.com/middleman/middleman-sprockets.git
- Install Bundler:
gem install bundler
bundle installinside the project root to install the gem dependencies.
- Run test cases:
bundle exec rake test
To run specs for an individual feature,
Copyright (c) 2012-2016 Thomas Reynolds. MIT Licensed, see LICENSE for details.