Archetype is a Compass/Sass based framework for authoring configurable, composable UI components and patterns.
Ruby CSS
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Archetype

Build Status Gem Version Documentation Status Dependency Status

Archetype is a Compass/Sass based framework for authoring configurable, composable UI components and patterns. The natural language syntax that Archetype provides allows designers and developer to discuss UI compositions using the same vocabulary.

Resources

Developing Archetype

If you're looking to contribute to Archetype, check out the CONTRIBUTING article.

Installation

Install the gem

[sudo] gem install archetype --pre

Instead of installing the gem directly via the command line, we recommend using Bundler to manage your gem dependencies.

Creating a new project with Archetype

compass create ~/workspace/your-project -r archetype --using archetype

Adding Archetype to an existing Compass project

In your config.rb, add

require "archetype"

Import Archetype into your Sass file

@import "archetype";

Learn more about Archetype configuration.

Credits

Author

Archetype was originally written by Eugene O'Neill.

Inspiration

Special Thanks

Acknowledgements

This project couldn't have been made possible without the amazing work by the following heroes:

  • Dave Gandy for his awesome work on FontAwesome
  • Chris Eppstein and other contributors of Compass for building an amazing framework, and for some great scaffolding code we've borrowed
  • Hampton Catlin, Nathan Weizenbaum, Chris Eppstein and contributors for making CSS fun again
  • Nicolas Gallagher and Jonathan Neal for some Normalize.css greatness
  • Nicolas Gallagher, Jonathan Neal, Kroc Camen, Paul Irish, and others for HTML5 Boilerplate