summaryrefslogtreecommitdiff
path: root/bower_components/bootstrap-sass-official/README.md
diff options
context:
space:
mode:
authorThomas Park <thomas@thomaspark.me>2015-01-22 22:36:20 -0500
committerThomas Park <thomas@thomaspark.me>2015-01-22 22:36:20 -0500
commit25f57ee1fe9773b08d95d5f7d6ba93e2db048f8f (patch)
tree8e4448eed6bce0fa1288321e18c2b4675b8cb393 /bower_components/bootstrap-sass-official/README.md
parent0a7f9e5bb684c185d309d1ac1079dfb8b36af33c (diff)
update bootstrap to 3.3.2
Diffstat (limited to 'bower_components/bootstrap-sass-official/README.md')
-rw-r--r--bower_components/bootstrap-sass-official/README.md78
1 files changed, 31 insertions, 47 deletions
diff --git a/bower_components/bootstrap-sass-official/README.md b/bower_components/bootstrap-sass-official/README.md
index 5a9692b1..2499ab02 100644
--- a/bower_components/bootstrap-sass-official/README.md
+++ b/bower_components/bootstrap-sass-official/README.md
@@ -1,4 +1,4 @@
-# Bootstrap for Sass [![Gem Version](https://badge.fury.io/rb/bootstrap-sass.svg)](http://badge.fury.io/rb/bootstrap-sass) [![Bower Version](https://badge.fury.io/bo/bootstrap-sass-official.svg)](http://badge.fury.io/bo/bootstrap-sass-official) [![Build Status](http://img.shields.io/travis/twbs/bootstrap-sass.svg)](http://travis-ci.org/twbs/bootstrap-sass)
+# Bootstrap for Sass [![Gem Version](https://badge.fury.io/rb/bootstrap-sass.svg)](http://badge.fury.io/rb/bootstrap-sass) [![Bower Version](https://badge.fury.io/bo/bootstrap-sass.svg)](http://badge.fury.io/bo/bootstrap-sass) [![Build Status](http://img.shields.io/travis/twbs/bootstrap-sass.svg)](http://travis-ci.org/twbs/bootstrap-sass)
`bootstrap-sass` is a Sass-powered version of [Bootstrap](http://github.com/twbs/bootstrap), ready to drop right into your Sass powered applications.
@@ -17,17 +17,10 @@ Please see the appropriate guide for your environment of choice:
In your Gemfile you need to add the `bootstrap-sass` gem, and ensure that the `sass-rails` gem is present - it is added to new Rails applications by default.
```ruby
-gem 'bootstrap-sass', '~> 3.3.1'
+gem 'bootstrap-sass', '~> 3.3.3'
gem 'sass-rails', '>= 3.2'
```
-It is also recommended to use [Autoprefixer](https://github.com/ai/autoprefixer-rails) with Bootstrap
-to add browser vendor prefixes automatically. Simply add the gem:
-
-```ruby
-gem 'autoprefixer-rails'
-```
-
`bundle install` and restart your server to make the files available through the pipeline.
Import Bootstrap styles in `app/assets/stylesheets/application.css.scss`:
@@ -41,12 +34,14 @@ Import Bootstrap styles in `app/assets/stylesheets/application.css.scss`:
`bootstrap-sprockets` must be imported before `bootstrap` for the icon fonts to work.
Make sure the file has `.css.scss` extension (or `.css.sass` for Sass syntax). If you have just generated a new Rails app,
-it may come with a `.css` file instead. If this file exists, it will be served instead of Sass, so remove it:
+it may come with a `.css` file instead. If this file exists, it will be served instead of Sass, so rename it:
```console
-$ rm app/assets/stylesheets/application.css
+$ mv app/assets/stylesheets/application.css app/assets/stylesheets/application.css.scss
```
+Then, remove all the `//= require` and `//= require_tree` statements from the file. Instead, use `@import` to import Sass files.
+
Do not use `//= require` in Sass or your other stylesheets will not be [able to access][antirequire] the Bootstrap mixins or variables.
Require Bootstrap Javascripts in `app/assets/javascripts/application.js`:
@@ -67,9 +62,9 @@ root.join('vendor', 'assets', 'bower_components').to_s.tap do |bower_path|
config.assets.paths << bower_path
end
# Precompile Bootstrap fonts
-config.assets.precompile << %r(bootstrap-sass/assets/fonts/bootstrap/[\w-]+\.(?:eot|svg|ttf|woff)$)
+config.assets.precompile << %r(bootstrap-sass/assets/fonts/bootstrap/[\w-]+\.(?:eot|svg|ttf|woff2?)$)
# Minimum Sass number precision required by bootstrap-sass
-::Sass::Script::Number.precision = [10, ::Sass::Script::Number.precision].max
+::Sass::Script::Number.precision = [8, ::Sass::Script::Number.precision].max
```
Replace Bootstrap `@import` statements in `application.css.scss` with:
@@ -92,35 +87,29 @@ Please make sure `sprockets-rails` is at least v2.1.4.
#### Rails 3.2.x
-Rails 3.2 is [no longer maintained for bugfixes](http://guides.rubyonrails.org/maintenance_policy.html), and you should upgrade as soon as possible.
-
-Starting with bootstrap-sass v3.1.1.1, due to the structural changes from upstream you will need these
-backported asset pipeline gems on Rails 3.2. There is more on why this is necessary in
-https://github.com/twbs/bootstrap-sass/issues/523 and https://github.com/twbs/bootstrap-sass/issues/578.
-
-```ruby
-gem 'sprockets-rails', '=2.0.0.backport1'
-gem 'sprockets', '=2.2.2.backport2'
-gem 'sass-rails', github: 'guilleiguaran/sass-rails', branch: 'backport'
-```
+bootstrap-sass is no longer compatible with Rails 3. The latest version of bootstrap-sass compatible with Rails 3.2 is v3.1.1.0.
### b. Compass without Rails
-Install the gem
-```sh
-gem install bootstrap-sass
+Install the gem:
+
+```console
+$ gem install bootstrap-sass
```
If you have an existing Compass project:
-```ruby
-# config.rb:
-require 'bootstrap-sass'
-```
+1. Require `bootstrap-sass` in `config.rb`:
-```console
-$ bundle exec compass install bootstrap
-```
+ ```ruby
+ require 'bootstrap-sass'
+ ```
+
+2. Install Bootstrap with:
+
+ ```console
+ $ bundle exec compass install bootstrap -r bootstrap-sass
+ ```
If you are creating a new Compass project, you can generate it with bootstrap-sass support:
@@ -144,24 +133,22 @@ If this happens, change the import order so that Compass mixins are loaded later
### c. Bower
-Using bootstrap-sass as a Bower package is still being tested. It is compatible with node-sass 0.8.3+. You can install it with:
+bootstrap-sass Bower package is compatible with node-sass 1.2.3+. You can install it with:
```console
-$ bower install bootstrap-sass-official
+$ bower install bootstrap-sass
```
-`bootstrap-sass` is taken so make sure you use the command above.
-
Sass, JS, and all other assets are located at [assets](/assets).
-By default, `bower.json` main field list only the main `bootstrap.scss` and all the static assets (fonts and JS).
+By default, `bower.json` main field list only the main `_bootstrap.scss` and all the static assets (fonts and JS).
This is compatible by default with asset managers such as [wiredep](https://github.com/taptapship/wiredep).
#### Node.js Mincer
-If you use [mincer][mincer] with node-sass, import bootstrap into like so:
+If you use [mincer][mincer] with node-sass, import bootstrap like so:
-In `application.css.ejs.scss` (NB **.css.ejs.css**):
+In `application.css.ejs.scss` (NB **.css.ejs.scss**):
```scss
// Import mincer asset paths helper integration
@@ -195,21 +182,18 @@ In the application Sass file, replace `@import 'bootstrap'` with:
#### Sass: Number Precision
-bootstrap-sass [requires](https://github.com/twbs/bootstrap-sass/issues/409) minimum [Sass number precision][sass-precision] of 10 (default is 5).
+bootstrap-sass [requires](https://github.com/twbs/bootstrap-sass/issues/409) minimum [Sass number precision][sass-precision] of 8 (default is 5).
Precision is set for Rails and Compass automatically.
When using ruby Sass compiler standalone or with the Bower version you can set it with:
```ruby
-::Sass::Script::Number.precision = [10, ::Sass::Script::Number.precision].max
+::Sass::Script::Number.precision = [8, ::Sass::Script::Number.precision].max
```
-Note that libsass and node-sass do not currently support the precision option, due to an open bug ([bug #364](https://github.com/sass/libsass/issues/364)) in libsass.
-
-
#### Sass: Autoprefixer
-Using [Autoprefixer][autoprefixer] with Bootstrap is recommended.
+Bootstrap requires the use of [Autoprefixer][autoprefixer].
[Autoprefixer][autoprefixer] adds vendor prefixes to CSS rules using values from [Can I Use](http://caniuse.com/).
#### JavaScript