Skip to content

Compass/compass-rails

Folders and files

NameName
Last commit message
Last commit date

Latest commit

f6391d0 · Jun 4, 2020
Jan 5, 2020
Feb 18, 2020
Jan 5, 2020
Dec 30, 2014
Jan 5, 2020
Jan 5, 2020
Feb 7, 2016
Jan 5, 2020
Dec 17, 2011
Dec 16, 2011
Jun 4, 2020
Jan 8, 2016
Jan 8, 2016
Feb 7, 2014

Repository files navigation

END OF LIFE - compass-rails

Don't use compass, it is no longer supported, see the compass statement

Build Status Code Climate Gem Version Coverage Status

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 5.2 and 6.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

Compass-rails is configured out of the box to work with Rails.

Advanced users can choose to add a config/compass.rb and take advantage of the Compass configuration reference as is.

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 'susy'

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

  1. This project is EOL. No more changes will be accepted.