Sass Bootstrap is a sleek, intuitive, and powerful front-end framework for faster and easier web development, created and maintained by Mark Otto and Jacob Thornton, and ported to Sass/Compass by Aaron Lademann.
To get started, check out the SASS Bootstrap Documentation!
Three quick start options are available:
- Download the latest release.
- Clone the repo:
$ git clone git://github.com/alademann/sass-bootstrap.git
.
Read the Getting Started page for information on the framework contents, basic template guidelines, and more.
Have a bug or a feature request? Please open a new issue. Before opening any issue, please search for existing issues and read the Issue Guidelines, written by Nicolas Gallagher.
SASS Bootstrap's docs are built using Jekyll and hosted on GitHub Pages. To view the Sass Bootstrap Docs locally, you'll need to install Jekyll to run a local server.
We have Sass set up to compile static CSS into the directory that Jekyll "watches" when instructed to automatically regenerate. If you are wanting to view documentation locally at localhost:9001
, we recommend uncommenting the auto: --auto
instruction in _config.yml
. This way, when running $ compass watch
, the updated CSS files injected into the directory Jekyll is watching will force regeneration of your static documentation files.
You should also comment out the remote url instruction in _config.yml
and uncomment the local url: /
declaration so that the dynamic {{ site.url }}
tags in the Jekyll templates will generate URLs that will work on your rig.
SASS Bootstrap makes use of Sassy CSS and Compass, so you'll need to install both ruby gems to generate static CSS.
$ sudo gem install sass
$ sudo gem install compass
Once you've installed these gems, simply run terminal from your repo directory, and run
$ compass watch
This will poll your Sass (.scss
) source files for changes, and automatically update your static CSS for you. To make this polling a little more user-friendly on a mac, we recommend installing Compass Growl
$ sudo gem install compass-growl
Then you can be notified via your native OSX growl notifications by adding this to your watch command
$ compass watch -r compass-growl
Please submit all pull requests against *sass-wip branches. If your pull request contains JavaScript patches or features, you must include relevant unit tests. All HTML and CSS should conform to the Code Guide, maintained by Mark Otto.
Mark Otto
Jacob Thornton
Aaron Lademann
Copyright 2013 Twitter, Inc and Aaron Lademann - under the Apache 2.0 license.