diff --git a/docs/COMPASS.md b/docs/COMPASS.md deleted file mode 100644 index 42909483..00000000 --- a/docs/COMPASS.md +++ /dev/null @@ -1,33 +0,0 @@ -# bootstrap-sass with Compass - -## New project - -Install the gem and create a new project using the gem. - -```console -gem install bootstrap-sass -compass create compass-project -r bootstrap-sass --using bootstrap -``` - -This will sort a few things out: - -* You'll get a starting `styles.scss` ready for your alterations, along with a copy of the variables file for easy modification. -* You'll get a compiled stylesheet compiled & ready to drop into your application -* We'll also copy the Bootstrap javascripts & images into their respective folders for you - -## Existing project - -Install the gem, add the require statement to the top of your configuration file, and install the extension. - -```console -gem install bootstrap-sass -``` - -```ruby -# In config.rb -require 'bootstrap-sass' -``` - -```console -compass install bootstrap -``` \ No newline at end of file diff --git a/docs/RAILS.md b/docs/RAILS.md deleted file mode 100644 index b7b104c8..00000000 --- a/docs/RAILS.md +++ /dev/null @@ -1,50 +0,0 @@ -# bootstrap-sass with Rails - -`bootstrap-sass` is easy to drop into Rails with the asset pipeline. - -## Installation - -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 'sass-rails', '>= 3.2' # sass-rails needs to be higher than 3.2 -gem 'bootstrap-sass', '~> 2.3.2.1' -``` - -`bundle install` and restart your server to make the files available through the pipeline. - -## Usage - -### CSS - -Import Bootstrap in an SCSS file (for example, `application.css.scss`) to get all of Bootstrap's styles, mixins and variables! We recommend against using `//= require` directives, since none of your other stylesheets will be [able to access][antirequire] the Bootstrap mixins or variables. - -```css -@import "bootstrap"; -``` - -You can also include optional bootstrap theme: - -```css -@import "bootstrap/theme"; -``` - -### Javascripts - -We have a helper that includes all Bootstrap javascripts. Put this in your Javascript manifest (usually in `application.js`) to - -```js -// Loads all Bootstrap javascripts -//= require bootstrap -``` - -You can also load individual modules, provided you also require any dependencies. You can check dependencies in the [Bootstrap JS documentation][jsdocs]. - -```js -//= require bootstrap/scrollspy -//= require bootstrap/modal -//= require bootstrap/dropdown -``` - -[antirequire]: https://github.com/thomas-mcdonald/bootstrap-sass/issues/79#issuecomment-4428595 -[jsdocs]: http://getbootstrap.com/javascript/#transitions