diff options
| author | Gleb Mazovetskiy <glex.spb@gmail.com> | 2017-10-13 01:51:03 +0300 |
|---|---|---|
| committer | Gleb Mazovetskiy <glex.spb@gmail.com> | 2017-10-13 01:55:56 +0300 |
| commit | 49709537118de7a74bcbb144f2fba64c66c0f315 (patch) | |
| tree | e3477fcba9ae212db215cca499b86e46c9003f4e /README.md | |
| parent | 6b9114249aedf7b83fa2289aeb6df1ff1bc412c0 (diff) | |
Drop Compass support, bump minimum Sass version
Compass is no longer maintained and hasn't seen a release for 3 years.
The compass gem locks Sass to version < 3.5.
However, we now need Sass v3.5+ due to
https://github.com/sass/sass/issues/2383
This commit removes compass support and bumps minimum Ruby Sass version
to v3.5.2.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 49 |
1 files changed, 8 insertions, 41 deletions
@@ -1,6 +1,6 @@ # Bootstrap Ruby Gem [](https://travis-ci.org/twbs/bootstrap-rubygem) [](https://rubygems.org/gems/bootstrap) -[Bootstrap 4][bootstrap-home] ruby gem for Ruby on Rails (Sprockets), Hanami (formerly Lotus) and Compass. +[Bootstrap 4][bootstrap-home] ruby gem for Ruby on Rails (Sprockets) and Hanami (formerly Lotus). For Sass versions of Bootstrap 3 and 2 see [bootstrap-sass](https://github.com/twbs/bootstrap-sass) instead. @@ -9,7 +9,7 @@ For Sass versions of Bootstrap 3 and 2 see [bootstrap-sass](https://github.com/t Please see the appropriate guide for your environment of choice: * [Ruby on Rails 4+](#a-ruby-on-rails) or other Sprockets environment. -* [Compass](#b-compass-without-rails) not on Rails. +* [Other Ruby frameworks](#b-other-ruby-frameworks) not on Rails. ### a. Ruby on Rails @@ -73,47 +73,14 @@ the concatenated `bootstrap` for faster compilation: //= require bootstrap ``` -### b. Compass without Rails +### b. Other Ruby frameworks -Install the gem: +If your framework uses Sprockets or Hanami, +the assets will be registered with Sprockets when the gem is required, +and you can use them as per the Rails section of the guide. -```console -$ gem install bootstrap -v 4.0.0.beta -``` - -**If you have an existing Compass project:** - -1. Require `bootstrap` in `config.rb`: - - ```ruby - require 'bootstrap' - ``` - -2. Install Bootstrap with: - - ```console - $ bundle exec compass install bootstrap - ``` - -**If you are creating a new Compass project, you can generate it with bootstrap support:** - -```console -$ bundle exec compass create my-new-project -r bootstrap --using bootstrap -``` - -or, alternatively, if you're not using a Gemfile for your dependencies: - -```console -$ compass create my-new-project -r bootstrap --using bootstrap -``` - -This will create a new Compass project with the following files in it: - -* [styles.scss](/templates/project/styles.scss) - main project Sass file, imports Bootstrap and variables. -* [_bootstrap-variables.scss](/templates/project/_bootstrap-variables.scss) - all of Bootstrap variables, override them here. - -Some bootstrap mixins may conflict with the Compass ones. -If this happens, change the import order so that Compass mixins are loaded later. +Otherwise you may need to register the assets manually. +Refer to your framework's documentation on the subject. ## Configuration |