search

vwall / compass-twitter-bootstrap

The twitter bootstrap ported to compass
722 stars 119 forks source link

readme

HEADS UP:

This gem is no longer being actively maintained.

If you need Bootstrap 3 on Sass you should use this: https://github.com/twbs/bootstrap-sass

Twitter Bootstrap - For Compass

Compass Twitter Bootstrap is Twitter's toolkit converted for Compass.

Demo App at https://github.com/vwall/Compass-Twitter-Bootstrap-Demo-App

Usage

Install the gem

gem install compass_twitter_bootstrap

Add it to your Gemfile

gem 'compass_twitter_bootstrap'

Bundle install

bundle install

Add it to your Compass config.rb

require 'compass_twitter_bootstrap'

Import it into your SCSS file

@import "compass_twitter_bootstrap";

Usage with asset pipeline(Rails 3.2)

Add these gems to your Gemfile. To learn about the new compass-rails gem, see https://github.com/Compass/compass-rails for more info.

gem 'compass_twitter_bootstrap'
gem 'compass-rails'

Bundle install

bundle install

Add it to your Application.rb

# Enable the asset pipeline
config.assets.enabled = true

Import it into your SCSS file

@import "compass_twitter_bootstrap"

Import twitter bootstrap responsive if you're looking for that

@import "compass_twitter_bootstrap_responsive"

Usage with Rails 3.1 (via plugin)

Install plugin

rails plugin install git://github.com/vwall/compass-twitter-bootstrap.git

Add it to your config/initializers/sass.rb

Rails.configuration.sass.tap do |config| ...

# twitter bootstrap
config.load_paths << Compass::Frameworks['twitter_bootstrap'].stylesheets_directory

...
end

Import it into your SCSS file

@import "compass_twitter_bootstrap"

Using Font Awesome

To use the font awesome font and icons simply change the standard import to:

@import "compass_twitter_bootstrap_awesome"

Using Javascripts with Rails Asset Pipeline

Javascript Libraries are located in vendor/assets/javascripts

Include them individually or

//=require bootstrap-all

to include all files

SCSS to SASS Conversion tip

To easily convert .scss files to .sass files you can use this little bash script:

$ for f in *.scss; do sass-convert -F scss -T sass $f ${f%%.*}.sass; done

To convert all twitter bootstrap .scss files to .sass (with overwrite):

$ for f in stylesheets/compass_twitter_bootstrap/*.scss; do sass-convert -F scss -T sass $f stylesheets_sass/compass_twitter_bootstrap/${f%%.*}.sass; done

$ for f in stylesheets/*.scss; do sass-convert -F scss -T sass $f stylesheets_sass/${f%%.*}.sass; done

Nice and easy :)

Upgrading

If you want to contribute and help out keeping this gem in sync with the latest release of Twitter Bootstrap, you should keep in mind that all mixins are prefixed with ctb-. With this prefixed we can't run into problems where the converted less-mixins conflict with native Compass names, parameters, ...

There is a Rake-task that will help you to fetch all recent changes from the Twitter Bootstrap master:

rake convert

When that is done

@remark: if some Ruby-genius wants to automate this feel free

TWITTER BOOTSTRAP

Bootstrap is Twitter's toolkit for kickstarting CSS for websites, apps, and more. It includes base CSS styles for typography, forms, buttons, tables, grids, navigation, alerts, and more.

To get started -- checkout http://getbootstrap.com!

AUTHORS

Mark Otto

Jacob Thornton

Copyright and License

Copyright 2012 Twitter, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE file, or at:

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.