History

baldo 98d5fde88a Updated bower libs.		2016-06-11 17:57:30 +02:00
..
_includes	Initial commit.	2014-05-12 20:08:19 +02:00
_layouts	Initial commit.	2014-05-12 20:08:19 +02:00
dist	Fix: Don't exclude dist directories of bower deps.	2014-05-31 20:21:21 +02:00
docs-assets	Initial commit.	2014-05-12 20:08:19 +02:00
examples	Initial commit.	2014-05-12 20:08:19 +02:00
fonts	Initial commit.	2014-05-12 20:08:19 +02:00
js	Initial commit.	2014-05-12 20:08:19 +02:00
lib	Initial commit.	2014-05-12 20:08:19 +02:00
.bower.json	Updated bower libs.	2016-06-11 17:57:30 +02:00
_config.yml	Initial commit.	2014-05-12 20:08:19 +02:00
about.html	Initial commit.	2014-05-12 20:08:19 +02:00
bower.json	Initial commit.	2014-05-12 20:08:19 +02:00
browserstack.json	Initial commit.	2014-05-12 20:08:19 +02:00
CNAME	Initial commit.	2014-05-12 20:08:19 +02:00
components.html	Initial commit.	2014-05-12 20:08:19 +02:00
composer.json	Initial commit.	2014-05-12 20:08:19 +02:00
CONTRIBUTING.md	Initial commit.	2014-05-12 20:08:19 +02:00
css.html	Initial commit.	2014-05-12 20:08:19 +02:00
customize.html	Initial commit.	2014-05-12 20:08:19 +02:00
DOCS-LICENSE	Initial commit.	2014-05-12 20:08:19 +02:00
Gemfile	Initial commit.	2014-05-12 20:08:19 +02:00
Gemfile.lock	Initial commit.	2014-05-12 20:08:19 +02:00
getting-started.html	Initial commit.	2014-05-12 20:08:19 +02:00
Gruntfile.js	Initial commit.	2014-05-12 20:08:19 +02:00
index.html	Initial commit.	2014-05-12 20:08:19 +02:00
javascript.html	Initial commit.	2014-05-12 20:08:19 +02:00
LICENSE	Initial commit.	2014-05-12 20:08:19 +02:00
LICENSE-MIT	Initial commit.	2014-05-12 20:08:19 +02:00
package.json	Initial commit.	2014-05-12 20:08:19 +02:00
Rakefile	Initial commit.	2014-05-12 20:08:19 +02:00
README.md	Initial commit.	2014-05-12 20:08:19 +02:00

README.md

Bootstrap

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.

This is the Sass version of Bootstrap. A port of Bootstrap from Less to Sass. This project is focused on being a 1:1 port of the original. Please do not submit issues or pull requests for issues with Bootstrap itself. Those should be pushed upstream in the Less version.

To get started, check out http://getbootstrap.com!

SASS: Quick start

Three quick start options are available:

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

SASS: Usage

You can use the Sass 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="./dist/css/bootstrap.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:dist/css/bootstrap.css

Quick start

Three quick start options are available:

Download the latest release.
Clone the repo: git clone https://github.com/twbs/bootstrap.git.
Install with Bower: bower install bootstrap.

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:

bootstrap/
├── css/
│   ├── bootstrap.css
│   ├── bootstrap.min.css
│   ├── bootstrap-theme.css
│   └── bootstrap-theme.min.css
├── js/
│   ├── bootstrap.js
│   └── 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 (bootstrap.*), as well as compiled and minified CSS and JS (bootstrap.min.*). Fonts from Glyphicons are included, as is the optional Bootstrap theme.

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

Bootstrap's documentation, included in this repo in the root directory, is built with Jekyll and publicly hosted on GitHub Pages at http://getbootstrap.com. The docs may also be run locally.

Running documentation locally

If necessary, install Jekyll (requires v1.x).
From the root /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.

Open http://localhost:9001 in your browser, and voilà.

Learn more about using Jekyll by reading its documentation.

Documentation for previous releases

Documentation for v2.3.2 has been made available for the time being at http://getbootstrap.com/2.3.2/ while folks transition to Bootstrap 3.

Previous releases and their documentation are also available for download.

Compiling CSS and JavaScript

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:

Install grunt-cli globally with npm install -g grunt-cli.
Navigate to the root /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. Uses recess and UglifyJS.

Only compile CSS and JavaScript - `grunt dist`

grunt dist creates the /dist directory with compiled files. Uses recess and UglifyJS.

Tests - `grunt test`

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

Watch - `grunt watch`

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

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.

With v3.1, we're moving from the Apache 2 to the MIT license for the Bootstrap code (not the docs). Please see the contributing guidelines for more information.

Community

Keep track of development and community news.

Follow @twbootstrap on Twitter.
Read and subscribe to The Official Bootstrap Blog.
Have a question that's not a feature request or bug report? Ask on the mailing list.
Chat with fellow Bootstrappers in IRC. On the irc.freenode.net server, in the ##twitter-bootstrap channel.

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

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.

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-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-bootstrap:~x.y.z

or like this:

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