Giter Club home page Giter Club logo

shibui's Introduction

Shibui โ€” Compass Plugin

The Heroku web apps CSS styleguide as a Compass extension.

To create your first project, you'll need to have the Shibui gem installed, this will include all the necessary dependencies.

Standalone Compass project

  1. (sudo) gem install shibui --pre
  2. compass create <project-name> -r shibui -u shibui

Rails 3.1 and above

  1. Add gem "shibui", ">= 0.0.2.alpha" to your Gemfile`.
  2. bundle install
  3. Require Shibui in your application stylesheet: @import "shibui";

Sinatra

Installation instructions needed.

Documentation

Documentation is in the works. If you can't get it to work bug [email protected].

Local development

Working on Shibui can be a little painful. Using the gem and Bundler will make you want to poke out your eyes with bycicle spokes. It is recommended to clone the Shibui repository and symlink to the stylesheets folder from within the application you are working on:

  1. git clone [email protected]:heroku/shibui.git
  2. ln -s ~/path/to/shibui/stylesheets ~/path/to/your/app/app/assets/stylesheets/shibui-dev
  3. echo "shibui-dev" > ~/path/to/your/app/.gitignore

Now you can include the Shibui development stylesheets in your application and can easily toggle between the local development version and the gem:

// When using the Shibui gem:
// @import "shibui";

// When working on Shibui locally:
@import "shibui-dev/shibui";

shibui's People

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.