0
0
mirror of https://github.com/twbs/bootstrap.git synced 2024-12-12 00:08:59 +01:00
The most popular HTML, CSS, and JavaScript framework for developing responsive, mobile first projects on the web. http://getbootstrap.com
Go to file
2013-11-06 13:59:07 -08:00
_includes Warn about IE8 + Respond.js + file:// problem in examples; fix #11019 2013-10-17 18:39:03 -07:00
_layouts Merge branch 'docs_welcome' 2013-10-13 23:19:17 -07:00
2.3.2 Fixes #10045: use v2.3.2 release link in old docs instead of master zip 2013-08-22 21:27:27 -07:00
dist Fixes #11295: Restore offset, push, and pull zero classes (e.g., .col-md-offset-0) 2013-11-06 13:03:08 -08:00
docs-assets update remaining version numbers 2013-11-06 13:19:18 -08:00
examples fix 1 remaining instance of #11349 2013-11-05 16:37:54 -08:00
fonts Remove execute permissions on fonts files. 2013-10-28 17:52:04 +04:00
js bump versions to v3.0.2 2013-11-06 12:57:28 -08:00
less Fixes #11295: Restore offset, push, and pull zero classes (e.g., .col-md-offset-0) 2013-11-06 13:03:08 -08:00
_config.yml update remaining version numbers 2013-11-06 13:19:18 -08:00
.editorconfig Remove Makefile section from .editorconfig 2013-07-27 14:04:46 -07:00
.gitignore update gitignore to restore the ruby-version ignore and rename section to all docs stuff 2013-10-06 18:35:07 -05:00
.travis.yml update node.js to v0.10.x (current stable) 2013-11-04 10:41:10 -08:00
about.html Update translation URL 2013-10-17 15:52:59 +08:00
bower.json update remaining version numbers 2013-11-06 13:19:18 -08:00
browserstack.json Temporarily disable IE BrowserStack testing, to fix the build 2013-08-06 17:56:20 -07:00
CNAME add cname 2013-07-26 23:04:03 -07:00
components.html fix #11378 2013-11-06 10:30:39 -08:00
composer.json Add a branch alias 2013-11-06 08:25:40 +01:00
CONTRIBUTING.md fix #11144 2013-10-17 11:21:06 -07:00
css.html Fixed links 2013-11-04 12:33:43 +02:00
customize.html Nuke trailing zeros 2013-10-14 15:06:58 +02:00
DOCS-LICENSE Nicer docs license name 2013-10-11 22:53:38 +02:00
getting-started.html Removed duplicated class change from migration instructions 2013-11-03 03:08:11 +00:00
Gruntfile.js add Grunt task to change version numbers; fixes #11332 2013-11-04 11:22:30 -08:00
index.html fixes #10372: two download buttons on homepage; also fixes broke button styles 2013-09-02 20:20:47 -07:00
javascript.html rm dummy 'src' attributes of <img>s & squelch validator warning; fixes #11216 2013-10-23 23:41:17 -07:00
LICENSE 'root' repo end 'insert_final_newline = true' 2013-04-22 17:19:56 +10:00
LICENSE-MIT Add Note About Changing to MIT 2013-10-15 13:06:27 -07:00
package.json bump versions to v3.0.2 2013-11-06 12:57:28 -08:00
README.md bump links to 3.0.2; change readme download to release URL format 2013-11-06 13:09:35 -08:00

Bootstrap Build Status devDependency Status

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, check out http://getbootstrap.com!

Quick start

Three quick start options are available:

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

  1. If necessary, install Jekyll (requires v1.x).
  2. 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.
  1. 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:

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

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

Authors

Mark Otto

Jacob Thornton

Copyright 2013 Twitter, Inc under the Apache 2.0 license.