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. - Install with Bower:
bower install sass-bootstrap-compass.
Read the Getting Started page for information on the framework contents, templates, examples 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.
You may use this JS Bin as a template for your bug reports.
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.
- If necessary, install Jekyll (requires v1.x).
- Install Sass and Compass by running
gem install sass && gem install compass. (may have to use admin priveledges) - Install Grunt dependencies by running
npm install -g grunt-cli && npm install. (may have to use admin priveledges) - Run
grunt dev- and everything will compile, and be watched... complete with Live Reload functionality! (Requires browser extensions) - Open http://localhost:9001 in your browser, and voila.
Sass Bootstrap uses Grunt with convenient methods for working with the framework. It's how we compile our code, run tests, and more. To use it, install the required dependencies as directed and then run some Grunt commands.
From the command line:
- Install
grunt-cliglobally withnpm install -g grunt-cli. - Install the necessary local dependencies via
npm install
When completed, you'll be able to run the various Grunt commands provided from the command line.
Unfamiliar with npm? Don't have node installed? That's a-okay. npm stands for node packaged modules and is a way to manage development dependencies through node.js. Download and install node.js before proceeding.
Run grunt to run js tests locally and compile the CSS and JavaScript into /dist.
grunt dist creates the /dist directory with compiled files.
Runs JSHint and QUnit tests headlessly in PhantomJS (used for CI).
This is a convenience method that watches all the assets required to run the documentation locally, and will recompile when you save any HTML / SCSS / JS file. Will also automatically refresh your browser if you install the LiveReload browser extension.
Should you encounter problems with installing dependencies or running Grunt commands, uninstall all previous dependency versions (global and local). Then, rerun npm install.
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.