Sass Bootstrap is focused on being a 1:1 translation from Twitter Bootstrap's Less to 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 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 and examples, and more.
Within the download you'll find the following directories and files, logically grouping common assets and providing both compiled and minified variations. You'll see something like this:
sass-bootstrap/
├── css/
│ ├── sass-bootstrap.css
│ └── sass-bootstrap.min.css
├── js/
│ ├── sass-bootstrap.js
│ └── sass-bootstrap.min.js
└── fonts/
├── glyphicons-halflings-regular.eot
├── glyphicons-halflings-regular.svg
├── glyphicons-halflings-regular.ttf
└── glyphicons-halflings-regular.woff
We provide compiled CSS and JS (sass-bootstrap.*), as well as compiled and minified CSS and JS (sass-bootstrap.min.*). Fonts from Glyphicons are included.
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 documentation, included in this repo in the root directory, is built with Jekyll and publicly hosted on GitHub Pages at http://alademann.github.io/sass-bootstrap/. The docs may also be run locally.
- From the Sass Bootstrap directory, run our handy setup script:
./setup.sh.
- If that doesn't work, try installing the Ruby gems separately by running
gem install bundler && bundle.
- From the root Sass Bootstrap directory, run
jekyll servein the command line.
- Windows users: run
chcp 65001first to change the command prompt's character encoding (code page) to UTF-8 so Jekyll runs without errors.
- Open http://localhost:9001 in your browser, and voila.
Learn more about using Jekyll by reading its documentation.
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. - Navigate to the root Sass Bootstrap directory, then run
npm install. npm will look at package.json and automatically install the necessary local dependencies listed there.
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 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 read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.
More over, 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.
Editor preferences are available in the editor config for easy use in common text editors. Read more and download plugins at http://editorconfig.org.
For transparency and insight into our release cycle, and for striving to maintain backward compatibility, Sass Bootstrap will be maintained under the Semantic Versioning guidelines as much as possible.
Releases will be numbered with the following format:
<major>.<minor>.<patch>
And constructed with the following guidelines:
- Breaking backward compatibility bumps the major (and resets the minor and patch)
- New additions without breaking backward compatibility bumps the minor (and resets the patch)
- Bug fixes and misc changes bumps the patch
For more information on SemVer, please visit http://semver.org/.
Mark Otto
Jacob Thornton
Aaron Lademann
Copyright 2013 Twitter, Inc and Aaron Lademann - under the Apache 2.0 license.