mirror of https://github.com/twbs/bootstrap.git synced 2024-11-29 11:24:18 +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

Chris Rebert 68fef8c247 Merge pull request #15867 from twbs/sauce-ios Use OS X 10.10 for Sauce iPhone simulator		2015-02-22 19:33:14 -08:00
dist	automatic grunt dist	2015-02-21 04:21:05 +00:00
docs	Fix copy/pasta'd id on accessibility skiplink callout	2015-02-21 15:02:40 +00:00
fonts	Add glyphicons fonts in woff2	2014-12-12 14:22:41 +01:00
grunt	Use OS X 10.10 for Sauce iPhone simulator	2015-02-22 19:01:36 -08:00
js	Merge pull request #15496 from twbs/15484-alternative	2015-01-28 11:05:40 -08:00
less	Fix #15652 : Set `position: relative` on .{radio,checkbox}-inline	2015-02-20 20:10:04 -08:00
test-infra	update shrinkwrap	2015-02-22 18:47:00 -08:00
_config.yml	bump versions	2015-01-19 08:32:13 -08:00
.editorconfig	Sorted various lines using atom/sort-lines	2014-10-22 14:06:09 +02:00
.gitattributes	.gitattributes: treat source maps as binary files	2015-02-16 22:27:31 -08:00
.gitignore	Use a Jekyll plugin instead of the `copy:configBridge` grunt task	2014-11-05 18:35:13 +01:00
.travis.yml	Travis: test against node.js 0.12.	2015-02-16 21:09:32 -08:00
bower.json	Add woff2 font file to bower main files	2015-01-23 14:24:27 +01:00
CNAME	add cname	2013-07-26 23:04:03 -07:00
composer.json	version bump	2014-10-29 08:56:20 -07:00
CONTRIBUTING.md	Fix a typo in contributing doc.	2015-02-22 13:59:15 +09:00
Gruntfile.js	Update dependencies.	2015-02-20 11:35:39 +02:00
LICENSE	Happy New Year 🎅	2015-01-01 01:23:48 +01:00
package.js	Added package.js for Meteor integration	2015-02-19 13:11:58 -08:00
package.json	bump grunt-saucelabs to ~8.6.0	2015-02-22 18:42:23 -08:00
README.md	Added package.js for Meteor integration	2015-02-19 13:11:58 -08:00

README.md

Bootstrap

Bootstrap is a sleek, intuitive, and powerful front-end framework for faster and easier web development, created by Mark Otto and Jacob Thornton, and maintained by the core team with the massive support and involvement of the community.

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

Quick start
Bugs and feature requests
Documentation
Contributing
Community
Versioning
Creators
Copyright and license

Quick start

Four 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.
Install with npm: npm install bootstrap.
Install with Meteor: meteor add twbs: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.css.map
│   ├── bootstrap.min.css
│   ├── bootstrap-theme.css
│   ├── bootstrap-theme.css.map
│   └── 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
    └── glyphicons-halflings-regular.woff2

We provide compiled CSS and JS (bootstrap.*), as well as compiled and minified CSS and JS (bootstrap.min.*). CSS source maps (bootstrap.*.map) are available for use with certain browsers' developer tools. Fonts from Glyphicons are included, as is the optional Bootstrap theme.

Bugs and feature requests

Have a bug or a feature request? Please first read the issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

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 v2.5.x).

Windows users: Read this unofficial guide to get Jekyll up and running without problems.

Install the Ruby-based syntax highlighter, Rouge, with gem install rouge.
From the root /bootstrap directory, run jekyll serve in the command line.
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.

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

Moreover, 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.

Community

Keep track of development and community news.

Follow @getbootstrap on Twitter.
Read and subscribe to The Official Bootstrap Blog.
Chat with fellow Bootstrappers in IRC. On the irc.freenode.net server, in the ##bootstrap channel.
Implementation help may be found at Stack Overflow (tagged twitter-bootstrap-3).

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, Bootstrap is maintained under the Semantic Versioning guidelines. Sometimes we screw up, but we'll adhere to those rules whenever possible.

Creators

Mark Otto

Jacob Thornton