GithubHelp home page GithubHelp logo

ksoderstrom / sass-twitter-bootstrap Goto Github PK

View Code? Open in Web Editor NEW

This project forked from jlong/sass-bootstrap-defunct

0.0 2.0 0.0 72 KB

CSS toolkit from Twitter converted to Sass. There are other ports of the bootstrap to Sass. This project is focused on being a 1:1 translation from Less to Sass.

Home Page: http://twitter.github.com/bootstrap

License: Apache License 2.0

sass-twitter-bootstrap's Introduction

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.

To get started, checkout http://getbootstrap.com!

Quick start

Three quick start options are available:

  • Download the latest release.
  • Clone the repo: git clone git://github.com/jlong/sass-twitter-bootstrap.git.
  • Install with Bower: bower install --save sass-bootstrap.

SASS: Usage

You can use the SASS Twitter Bootstrap by dropping the compiled CSS into any new project and start cranking.

Because SASS always outputs standard css, just link to the final output like normal:

<link rel="stylesheet" type="text/css" href="bootstrap-2.3.2.css">

For more info, refer to the docs!

SASS: Basic modification

You can learn more about SASS at:

sass-lang.com

SASS runs as a local GEM on your system. You can run sass --watch lib/bootstrap.scss:bootstrap-2.3.2.css

Versioning

For transparency and insight into our release cycle, and for striving to maintain backward compatibility, 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/.

Bug tracker

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.

Community

Keep track of development and community news.

SASS: Developers

We have included a Rakefile with convenience methods for working with the SASS Bootstrap library.

  • build - rake build This will run the less compiler on the bootstrap lib and regenerate the docs dir. The lessc compiler is required for this command to run.

  • watch - rake watch This is a convenience method for watching your Sass files and automatically building them whenever you save.

Compiling CSS and JavaScript

Bootstrap includes a makefile with convenient methods for working with the framework. Before getting started, be sure to install the necessary local dependencies:

$ npm install

When completed, you'll be able to run the various make commands provided:

build - make

Runs the recess compiler to rebuild the /less files and compiles the docs. Requires recess and uglify-js.

test - make test

Runs jshint and qunit tests headlessly in phantomjs (used for ci). Depends on having phantomjs installed.

watch - make watch

This is a convenience method for watching just Less files and automatically building them whenever you save. Requires the Watchr gem.

Should you encounter problems with installing dependencies or running the makefile commands, be sure to first uninstall any previous versions (global and local) you may have installed, and then rerun npm install.

Contributing

Please submit all pull requests against *-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.

Thanks!

Authors

Mark Otto

Jacob Thornton

SASS: Conversion less to Sass

The Twitter Bootstrap was lovingly converted to Sass by:

John W. Long

Jeremy Hinegardner

m5o

smt

And others

SASS: Conversion Quick Tips

  • replace @ with $
  • replace . with @include for mixins
  • replace spin with adjust-hue
  • add !default to variable definitions
  • replace #gradient > .vertical with @include gradient-vertical
  • replace #grid > .style with @include grid-style
  • use grid-core and grid-fluid mixins instead of #grid > .core and #grid > .fluid
  • use font-shorthand instead of #font > .shorthand
  • replace fadein with fade-in
  • move @import for reset below mixins, because it uses tab-focus mixin in bootstrap.scss
  • explicitly provide .clearfix, .hide-text and .input-block-level for compatibility with LESS output
  • pass grid-* mixin arguments to generators, because otherwise the generator mixins will use the default variables pull transition definition into variable

SASS: Installation via Composer

If you already use Composer, the php dependency manager, installing sass-twitter-bootstrap is as simple as typing :

composer.phar require jlong/sass-twitter-bootstrap:x.y.z

This will install version x.y.z from packagist.org

You'll probably want to make sure you get minor updates, like this:

composer.phar require jlong/sass-twitter-bootstrap:~x.y.z

or like this:

composer.phar require jlong/sass-twitter-bootstrap:x.y.*

Copyright and license

Copyright 2012 Twitter, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE file, or at:

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

sass-twitter-bootstrap's People

Contributors

andreapavoni avatar asecondwill avatar caniszczyk avatar copiousfreetime avatar erikhuisman avatar fat avatar greg0ire avatar jlong avatar jodal avatar kaystrobach avatar laurentchin avatar lsirivong avatar m5o avatar matthewpennell avatar mdo avatar noahblon avatar nragaz avatar pamelafox avatar pilt avatar rafbm avatar raphaelz avatar roverwolf avatar sankage avatar silentworks avatar sindresorhus avatar smt avatar trisweb avatar ubermajestix avatar wrenbjor avatar wrightlabs 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.