compass-rails
We Take Pull Requests!
Compass rails is an adapter for the Compass Stylesheet Authoring Framework for Ruby on Rails.
Since Compass v0.12.0, this is the only way to use compass with your rails application.
Supports Rails 3.2, 4.x releases.
Installation
Add the compass-rails gem line to your application's Gemfile
gem 'sass-rails'
gem 'compass-rails'
If you are using any Compass extensions, add them to this group in your Gemfile.
And then execute:
$ bundle
Usage
Change your application.css to application.css.scss or application.css.sass and then @import compass and your own stylesheets to your hearts content. E.g.:
@import "compass";
@import "your_project/mixins";
@import "your_project/base";
or
Use application.css to require files that use compass features. Ex:
/*
*= require styleguide_full_of_compass_stuff
*/
Don't use *= require something within your SCSS or SASS files. You're gonna have a bad time.
Configuration
If you have a compass configuration file (recommended) then you can
use the Compass configuration
reference
as is. If you choose to configure compass from your rails configuration
files, then you should understand that the compass configuration
options explained there will be methods and properties on the config.compass
configuration object exposed to rails within any configuration block.
Installing Compass extensions
Step 1: Add it to your Gemfile and run the bundle command to install it.
Step 2: Install the extension's assets: bundle exec compass install
<extension/template>
For example, if you want to use susy.
# Gemfile
gem 'compass-rails'
gem 'compass-susy-plugin'
then run:
$ bundle
$ bundle exec compass install susy
if you are using the rails configuration files you should add:
config.compass.require "susy"
to your application.rb configuration file.
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Added some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request