Skip to content

Latest commit

 

History

History
103 lines (68 loc) · 4.36 KB

README.md

File metadata and controls

103 lines (68 loc) · 4.36 KB
Raw

Compass Recipes project status

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

Demos

Note: These are demos of the repository at its current state, not the last stable gem. To get the most up-to-date recipes, please see Installation for instructions on installing the repo at his current state*

Types of Recipes

  • Backgrounds - Background patterns, gradients.
  • Color Advanced color functions like brightness()
  • Effects - Visual effects like bevel and cutout
  • Form skins - Only one at the moment.
  • Icons - Includes webfont icon support and a few open source fonts.
  • Layout - Vertical centering and box layout shortcuts.
  • Media queries - Predefined queries for common device widths. Experimental: Uses compass --pre
  • Shadows - A wide collection of shadows which use pseudo elements to create fold effects, etc.
  • Shapes - Geometric and iconic shapes, created only with CSS
  • Shared - Common CSS tricks and hacks.
  • UI Element styling for buttons, etc.
  • View other potential items: http://moox.github.com/compass-recipes/issues/

Installation

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

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-./}compass-recipes/stylesheets' using additional_import_paths or add_import_path (see Compass configuration reference

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;
}

Authors/Maintainers

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

Sous Chefs

While Maxime and David are the primary project maintainers, these people have provided lots of the core ideas and techniques in the recipes. They are the bacon in our BLT: @simurai, @chriscoyier, @leaverou, @necolas.

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.

Build Documentation

First you need bundle

bundle install

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

bundle exec rake pages

Additional Resources

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

  • Normalize - The standard of CSS normalizations.
  • 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

Copyright (c) 2012 Maxime Thirouin

Released under MIT Licence