Skip to content

SASS Bootstrap - Focused on being a 1:1 translation from Twitter Bootstrap's Less to Sassy CSS (SCSS) compiled using Compass

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE
MIT
LICENSE-MIT
Notifications You must be signed in to change notification settings

RamIdeas/sass-bootstrap

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sass Bootstrap v3.0.21 Build Status devDependency Status

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!

Quick start

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.

What's included

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.

Bugs and feature requests

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.

Documentation

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.

Running documentation locally

  1. 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.
  1. From the root Sass Bootstrap directory, run jekyll serve in the command line.
  • Windows users: run chcp 65001 first to change the command prompt's character encoding (code page) to UTF-8 so Jekyll runs without errors.
  1. Open http://localhost:9001 in your browser, and voila.

Learn more about using Jekyll by reading its documentation.

Compiling CSS and JavaScript

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.

Install Grunt

From the command line:

  1. Install grunt-cli globally with npm install -g grunt-cli.
  2. 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.

Available Grunt commands

Build - grunt

Run grunt to run tests locally and compile the CSS and JavaScript into /dist.

Only compile CSS and JavaScript - grunt dist

grunt dist creates the /dist directory with compiled files.

Tests - grunt test

Runs JSHint and QUnit tests headlessly in PhantomJS (used for CI).

Watch - grunt dev

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.

Troubleshooting dependencies

Should you encounter problems with installing dependencies or running Grunt commands, uninstall all previous dependency versions (global and local). Then, rerun npm install.

Contributing

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.

Versioning

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/.

Authors

Mark Otto

Jacob Thornton

Aaron Lademann

Copyright and license

Copyright 2013 Twitter, Inc and Aaron Lademann - under the Apache 2.0 license.

About

SASS Bootstrap - Focused on being a 1:1 translation from Twitter Bootstrap's Less to Sassy CSS (SCSS) compiled using Compass

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE
MIT
LICENSE-MIT

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 61.5%
  • CSS 37.0%
  • Other 1.5%