Quick Start

Using the themes is as easy as downloading a CSS file and replacing the one that comes with Bootstrap.

The themes are also available via CDN at BootstrapCDN.

Customization

To modify a theme or create your own, follow the steps below in your terminal. You'll need to have Git and Node installed.

  1. Download the repository: git clone https://github.com/thomaspark/bootswatch.git

  2. Install dependencies: npm install

  3. Make sure that you have grunt available in the command line. You can install grunt-cli as described on the Grunt Getting Started page.

  4. Decide if you want to use Less or Sass for customizing your theme.

    • For Less, modify variables.less and bootswatch.less in one of the theme directories, or create your own in /custom.

    • For Sass, modify instead the _variables.scss and _bootswatch.scss files.

  5. Type grunt swatch:[theme] to build the Less based CSS for a theme, e.g., grunt swatch:amelia for Amelia. Or type grunt swatch to build them all at once. If you are using Sass, type grunt swatch_scss:[theme] instead.

  6. You can run grunt to start a server, watch for any changes to the LESS files, and automatically build a theme and reload it on change. Run grunt server for just the server, and grunt watch for just the watcher.

Here are additional tips for customizing Bootstrap.

API

You can use the API to integrate the themes with your platform. Get:

https://bootswatch.com/api/3.json

This returns an object with a version and a themes property. themes is an array with the following properties:

  • name
  • description
  • preview
  • thumbnail
  • css
  • cssMin
  • cssCdn
  • less
  • lessVariables

Here's a demo of the API in action.

Bookmarklet

Drag Bootswatchlet into your bookmarks bar, and use it on Bootstrap-based sites to see how they'd look with a theme.

Tools

GlyphSearch is a tool for searching icons from Glyphicons, Font Awesome, and other popular icon font libraries.

FontCDN is a tool for searching web fonts from Google Fonts.

Support

Show your support for Bootswatch by buying official gear.

T-shirts based on several themes including Cyborg, Flatly, and Slate are available at Spreadshirt.

Stickers are available at Sticker Mule.

Donations are also accepted via PayPal and Gratipay.