https://github.com/Compass/compass-rails

compass rails integration
https://github.com/Compass/compass-rails

Last synced: 3 months ago
JSON representation

compass rails integration

• Host: GitHub
• URL: https://github.com/Compass/compass-rails
• Owner: Compass
• License: mit
• Created: 2011-12-16T22:59:59.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2021-02-08T19:47:51.000Z (almost 4 years ago)
• Last Synced: 2024-05-19T13:41:54.143Z (6 months ago)
• Language: Ruby
• Homepage:
• Size: 563 KB
• Stars: 592
• Watchers: 23
• Forks: 277
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# END OF LIFE - compass-rails

**Don't use compass, it is no longer supported, see the [compass statement](https://github.com/Compass/compass/pull/2094)**

[![Build Status](https://travis-ci.org/Compass/compass-rails.svg?branch=master)](https://travis-ci.org/Compass/compass-rails)

[![Code Climate](https://codeclimate.com/github/Compass/compass-rails.svg)](https://codeclimate.com/github/Compass/compass-rails)

[![Gem Version](https://badge.fury.io/rb/compass-rails.svg)](http://badge.fury.io/rb/compass-rails)

[![Coverage Status](https://coveralls.io/repos/Compass/compass-rails/badge.svg)](https://coveralls.io/r/Compass/compass-rails)

Compass rails is an adapter for the [Compass Stylesheet Authoring

Framework](http://compass-style.org) for [Ruby on Rails](http://rubyonrails.org/).

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

```ruby

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.:

```scss

@import "compass";

@import "your_project/mixins";

@import "your_project/base";

```

*or*

Use `application.css` to require files that use compass features. Ex:

```css

/*

 *= 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](http://compass-style.org/help/documentation/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

`

For example, if you want to use susy.

```ruby

# 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:

```ruby

config.compass.require "susy"

```

to your application.rb configuration file.

## Contributing

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