Giter VIP home page Giter VIP logo

sass-bootstrap's Introduction

Sass Bootstrap v3.0.0

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!

Quick start

Three quick start options are available:

Read the Getting Started page for information on the framework contents, basic template guidelines, and more.

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.

Documentation

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.

Running Jekyll locally alongside Sass / Compass

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.

Compiling CSS

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

Contributing

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.

Authors

Mark Otto

Jacob Thornton

Aaron Lademann

Copyright and license

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

sass-bootstrap's People

Contributors

acmetech avatar alademann avatar andriijas avatar ansman avatar bradly avatar buraktuyan avatar caniszczyk avatar cgunther avatar copiousfreetime avatar cvrebert avatar dudebout avatar fat avatar ghusse avatar jacobrask avatar jlong avatar lookfirst avatar m5o avatar mdo avatar nragaz avatar pamelafox avatar patrickhlauke avatar purwandi avatar rvagg avatar smaboshe avatar smerik avatar sspmark avatar synchro avatar vickash avatar wrightlabs avatar yohn avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.