/jeet

A light, semantic, responsive, CSS framework built from the best parts.

Primary LanguageJavaScript

alt text

####Installation npm install -g stylus jeet

####Standalone Usage stylus -u jeet -w -c

####Node Usage Example

var connect = require('connect')
    , stylus = require('stylus')
    , jeet = require('jeet');

var server = connect();

function compile(str, path) {
    return stylus(str)
        .set('filename', path)
        .use(jeet());
}

server.use(stylus.middleware({
    src: __dirname
    , compile: compile
}));

In the example above, Jeet will be implicitly included in your project's Stylus files. This means you don't have to declare @import 'jeet' anywhere and you'll still get Jeet functionality everywhere. If, for some reason, this doesn't suit your fancy, and you like @importing stuff, you can explicitly disable this functionality by modifying the above line:

.use(jeet({ implicit: false }));

####Syntax Quick Reference https://github.com/mojotech/jeet/blob/master/lib/index.styl

####HTML Boilerplate https://github.com/mojotech/jeet-html

####Roots Integration https://github.com/mojotech/jeet-roots

####How to Install/Use Jeet in Rails 4 Asset Pipeline

  • Install NodeJS on your development machine
  • Append gem 'stylus', :git => 'git@github.com:lucasmazza/ruby-stylus.git' to your Gemfile
  • bundle
  • npm install jeet
  • Add Stylus.use('jeet') if defined? (Stylus) to config/application.rb inside your class Application
  • Create and edit custom.css.styl in app/assets/stylesheets
  • rails s
  • Enjoy. Heroku's Cedar Stack supports Rails and Node out of the box. Nice.

####Help! npm is throwing permission errors! You're probably trying to sudo everything aren't you? That's bad juju! sudo chown -R $USER /usr/local will fix this. You might be interested in reinstalling all your global npm packages without sudo as well. Don't believe us? Here's a blog post on the subject by the maintainer of npm himself.

####License Jeet is licensed under GPL Version 3