Getting Started with SASS for Drupal and Zen

Part 1: Installing and configuring SASS/Compass

Want to get started using SASS/Compass with Drupal? And fast? This series will give you an introduction to SASS/Compass, plus how get started using it with Drupal right away using the Zen base theme. Welcome to Part 1: Installing and Configuring SASS/Compass.

In case you missed it, SASS (or Syntactically Awesome Style Sheets), is a new way of writing CSS that can save you time, future-proof your code, and make your stylesheets–like the acronym says–Awesome. SASS is a CSS preprocessor, which means that you can write your stylesheets in SASS, complete with all its nifty features, and compile it to regular CSS that your browser can read. On its own, SASS gives you the ability to use nested styles, variables, functions, operators, and a whole lot more.

While SASS is great on its own, it's even better when you add Compass to the mix. Compass Core describes itself as "a design-agnostic framework that provides common code that would otherwise be duplicated across other frameworks and extensions." Basically it gives you a huge library of commonly-used styles and functions to work with, such as cross-browser CSS3 code, typography rules, and tools for image sprite generation.

Now that you're (hopefully!) excited to start using Compass/SASS, let's move on to the tutorial:

Install SASS/Compass

To start, you need a copy of SASS and Compass on your computer. There are a couple different ways to install them:

A. Install SASS/Compass using a Ruby gem (the package manager for Ruby).

There are several tutorials on how to install using this method, and they vary depending on what operating system you use. So check out one of these tutorials and come back for step 2. Don't worry, we'll wait.

i. http://thesassway.com/beginner/getting-started-with-sass-and-compass
ii. http://compass-style.org/install/

B. Use an application that manages SASS/Compass for you.

This is probably the easiest way to get up and running with SASS, especially if you're not comfortable working on the command line. Some of these apps also boast nice features, such as automatic browser reloading and support for additional preprocessors and libraries, such as LESS and Bourbon.

i. Scout (Mac/Windows, Free)
ii. Compass.app (Mac/Windows/Linux, $10 at time of writing)
iii. CodeKit (Mac, $28 at time of writing)

Configure SASS/Compass to watch your project for changes

Now that we have it installed, how do we use it? Essentially, we need to tell Compass to "watch" a certain folder or project. Then each time we make a change to a file in that project, SASS/Compass will compile it into a CSS file that our browsers can read.

If you decided to use an app to manage SASS/Compass, adding a new project is probably as simple as clicking a "new" or "add" button in your app and selecting your project folder. (Hint: Your project folder will be where config.rb is located, which we'll discuss in a bit).

If you're using a command line interface, tell Compass to watch a folder with:

compass watch [path/to/project]

More information on Compass command line options can be found at:

i. http://compass-style.org/help/tutorials/command-line/

Install Zen

Typically at this point, we would talk about how to configure your project for SASS/Compass. However, the über-popular Zen base theme for Drupal comes with some great defaults, so let's jump right in to using SASS with Zen.

Start by downloading Zen (at least version 5.4) from Drupal.org and creating a new sub theme, which we'll call "mytheme".

i. Instructions with Drush: https://drupal.org/node/2021609
ii. Instructions without Drush: https://drupal.org/node/1549668

Then tell compass to "watch" your new subtheme by adding the "mytheme" project folder to your app or using the command line interface as described above.

Zen File Structure

Now that we have "mytheme" set up, let's look at the file structure:

Diagram of Zen Subtheme File Structure
Fig 1: Zen Subtheme File Structure

On the right side of Fig. 1, we find some standard Drupal theme elements: folders for images, templates, and javascript; template.php for our custom code and preprocess functions; an info file for theme configuration; and logo, favicon, theme settings, etc (not pictured).

But the left side of the diagram is where all the SASS magic happens. Let's quickly go over each of the components:

A. Config.rb

This file is for SASS and Compass configuration, such as the location of your sass and css directories, whether to show debug info, etc. Zen comes with this file pre-configured, so there's not much we need to do here. For more options, check out:

i. http://compass-style.org/help/tutorials/configuration-reference/

  • Tip: Download the FireSASS extension for FireBug and set the "firesass" flag to TRUE in Zen's config.rb to get better line numbers and file references in FireBug

B. CSS

This directory contains all of the compiled CSS that is used by Drupal. Don't edit these files directly! Instead, move on to the "sass" folder.

C. SASS

On a typical theme, this folder is where you'll be spending 90% of your time. It contains all the files where you can add the colors, fonts, and styles needed for your theme. In part 2 of this blog series, we'll cover some SASS basics and where to put your code.

D. Sass Extensions

This is where you can put any additional or custom extensions you'd like to use in your theme. Zen comes pre-loaded with the "Zen Grids" responsive grid extension. For more info on extensions, see:

i. http://compass-style.org/help/tutorials/extensions/
ii. http://zengrids.com/

Next Time

Tune in next week for Part 2: Using SASS/Compass in Your Drupal Theme. Can't wait? Check out http://sass-lang.com/guide to get started.

comments powered by Disqus

Say hello. Tell us about the change you'd like to create in the world.