Compass Recipes

A series of Compass and Sass mixins and functions for creating delicious CSS effects.

Compass Recipes is currently under active development. While it's being already used on multiple projects (even in production), you may encounter some issues. Please try it out in a project, and make suggestions or report bugs ! Your feedback matters.

Online Demos

If you want to view the Sass(scss) source of a demo, remember to find the appropriate .scss file of the deserved s.css (e.g. : open it from the source & switch extension).

Availables Recipes

Backgrounds - Background patterns, gradients.
Color Variables Names, advanced color functions like brightness() & color scheme functions
Effects - Visual effects like glass, bevel, cutout or ribbon
Form skins - Only one at the moment. Please add yours :)
Icon Fonts - Includes icon fonts helper and a few open source fonts as a compass extension (more info)
Image - More image mixins (& functions) than Compass deserve (dimensions, inline, simple spriting)
Layout - Vertical centering and box layout shortcuts.
Media queries - Shortcuts for media queries.
Shadows - A wide collection of shadows which use pseudo elements to create fold effects, etc.
Shapes - Geometric and iconic shapes, created only with CSS
UI Lots of element styling for loader, menu, overlay, separator, tooltip, etc.
Utilities Very usefull utilities, trick, hacks
View other potential icoming items

Installation

Compass Recipes is available as a gem on RubyGems.org, so installation is quite easy.

(sudo) gem install compass-recipes

*If you want all latests recipes, you can just checkout the recipes (or download as zip) and add 'your-path-here-or-your-path-here-or-./compass-recipes/stylesheets' using additional_import_paths or add_import_path (see Compass configuration reference).

More informations on the Wiki*

Usage

When compass-recipes installed, you just need to require the compass plugin in your project

require 'compass-recipes'

Then you can include some recipes like this

@import "recipes/shape/triangle";
.my-triangle
{
    @include triangle;
}

Like Compass does, you can include all recipes in a folder like this

@import "recipes/shape";

.my-triangle
{
    @include triangle;
}

.my-square
{
    @include square;
}

Support/Community

Compass Recipes has for now a little community because this projet is (for now) only at the beginning.

@Compass_Recipes on Twitter is a great place to ask very short questions that you want answered quickly.

There is also an IRC channel, #compass-recipes on irc.freenode.net.

Feel free to ping @MoOx if he’s there to get his attention quickly. If there’s no one on #compass-recipes, you can try the #compass or maybe the #sass channel on IRC.

If you have a longer question (or no one’s around on IRC at the moment), drop a mail at [email protected]. You’ll usually get a response within a couple hours or so.

Open to All

If you have a nifty CSS trick that makes sense to be abstracted (and isn't already in another Github repo), please fork and submit a pull request. Note: If you are not the author of the CSS trick, you must get their permission before adding.

Fonts

All fonts are repackaged using Fontsquirrel. Licences are distributed with the fonts.

Build Documentation

You do not need to build documentation for testing your recipes. Just run compass watch/compile at the root of the repository.

First you need bundle

bundle install

Then, to build the gh-pages from the tests/, you need to call

bundle exec rake pages

This process create the pages & commit them to your gh-pages branch.

Authors/Maintainers

Compass Recipes is maintained by Maxime Thirouin, a french front-end web developer, and David Kaneda, previously creative director at Sencha.

See all contributors

While Maxime and David are the primary project maintainers, most of the core ideas and techniques in the recipes are not from them.

Credits & Thanks:

@chriscoyier (shapes & lots of tricks)
@leaverou (backgrounds patterns)
@necolas (normalize & tricks)
@simurai (awesomes design stuffs)
All of the people who contribute to the recipes (all names should be in each recipes source)

Additional Resources

Some other great CSS/SCSS/design projects for making delicious websites:

Subtle Patterns - Great collection of free background patterns, some of which are not possible with CSS alone.
Animate.sass - A bevy of pre-defined keyframe animations.
OMG Text - Some super-rad text effects using text-shadow

License

Released under MIT Licence