README

Bootswatch is a collection of free themes for Bootstrap. Check it out at bootswatch.com.

This fork is a port to SASS so you can include swatches in your Bootstrap SASS project.

Usage

####CSS Download the bootstrap.min.css file associated with a theme and replace Bootstrap's default stylesheet.

The themes are also hosted on BootstrapCDN.

####SCSS / Bower Add it to your bower_components directory by executing

bower install bootswatch-sass

To use a theme in your Sass project, structure your imports in this order

import the offial bootstrap-sass variables
import bootswatch theme variables
import offical bootstrap-sass
import bootswatch theme additional file

E.g - Importing the paper theme:

    @import "bower_components/bootstrap-sass-official/assets/stylesheets/bootstrap/variables";
    @import "bower_components/bootswatch-sass/paper/variables";
    @import "bower_components/bootstrap-sass-official/assets/stylesheets/bootstrap/bootstrap";
    @import "bower_components/bootswatch-sass/paper/bootswatch-scss/readable/bootswatch";

Customization

Bootswatch is open source and you’re welcome to modify the themes.

Each theme consists of two SASS files. _variables.scss, which is included by default in Bootstrap, allows you to customize these settings. _bootswatch.scss introduces more extensive structural changes.

Check out the Help page for more details on building your own theme.

API

A simple API is available for integrating your platform with Bootswatch. Send your request to http://guru-digital.github.io/bootswatch-sass/api/3.json.

The swatch objects are returned in an array called themes, each one with the following properties: name, description, preview, thumbnail, css, cssMin, scss, and scssVariables.

More info at http://guru-digital.github.io/bootswatch-sass/help/#api