thomaspark/bootswatch

Themes for Bootstrap

Installs: 22 292

Dependents: 5

Suggesters: 0

Stars: 9 614

Watchers: 523

Forks: 2 725

Open Issues: 17

Language:JavaScript

Type:component

v4.0.0-beta.2 2017-11-04 06:14 UTC

README

Bootswatch Logo

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

Usage

Download the bootstrap.min.css file associated with a theme and replace Bootstrap's default stylesheet. You must still include Bootstrap's JavaScript file to have functional dropdowns, modals, etc.

You can install as a package via npm with the command npm install bootswatch.

You can also hotlink the themes via CDN at BootstrapCDN.

Lastly, you can import a theme into your styles using SASS.

@import "bootswatch/theme/variables";
@import "bootstrap/scss/bootstrap";
@import "bootswatch/theme/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 the 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. More info can be found on the Help page.

Contributing

It's through your contributions that Bootswatch will continue to improve. You can contribute in several ways.

Issues: Provide a detailed report of any bugs you encounter and open an issue on GitHub.

Documentation: If you'd like to fix a typo or beef up the docs, you can fork the project, make your changes, and submit a pull request.

Code: Make a fix and submit it as a pull request. When making changes, it's important to keep the CSS and SASS versions in sync. To do this, be sure to edit the SASS source files for the particular theme firsst, then run the tasks grunt swatch to build the CSS.

Donation: Donations are gratefully accepted via PayPal and Bitcoin at 1EMqwwjqJrfyoPqmxNM7buzU6DmySZnHBK.

Author

Thomas Park

Thanks

Mark Otto and Jacob Thornton for Bootstrap.

Jenil Gogari for his contributions to the Flatly theme.

James Taylor for cors-lite.

Corey Sewell for SASS conversion.

Copyright and License

Copyright 2014-2017 Thomas Park

Code released under the MIT License.