README.md 6.67 KB
Newer Older
1
# [Bootstrap](http://getbootstrap.com)
2
3
4
5
![Bower version](https://img.shields.io/bower/v/bootstrap.svg?style=flat)
[![npm version](https://img.shields.io/npm/v/bootstrap.svg?style=flat)](https://www.npmjs.com/package/bootstrap)
[![Build Status](https://img.shields.io/travis/twbs/bootstrap/master.svg?style=flat)](https://travis-ci.org/twbs/bootstrap)
[![devDependency Status](https://img.shields.io/david/dev/twbs/bootstrap.svg?style=flat)](https://david-dm.org/twbs/bootstrap#info=devDependencies)
6
[![Selenium Test Status](https://saucelabs.com/browser-matrix/bootstrap.svg)](https://saucelabs.com/u/bootstrap)
Jacob Thornton's avatar
Jacob Thornton committed
7

8
Bootstrap is a sleek, intuitive, and powerful front-end framework for faster and easier web development, created by [Mark Otto](https://twitter.com/mdo) and [Jacob Thornton](https://twitter.com/fat), and maintained by the [core team](https://github.com/orgs/twbs/people) with the massive support and involvement of the community.
Mark Otto's avatar
Mark Otto committed
9

10
To get started, check out <http://getbootstrap.com>!
Mark Otto's avatar
Mark Otto committed
11

12
13
## Table of contents

14
15
16
17
18
19
20
21
- [Quick start](#quick-start)
- [Bugs and feature requests](#bugs-and-feature-requests)
- [Documentation](#documentation)
- [Contributing](#contributing)
- [Community](#community)
- [Versioning](#versioning)
- [Creators](#creators)
- [Copyright and license](#copyright-and-license)
Mark Otto's avatar
Mark Otto committed
22

Mark Otto's avatar
Mark Otto committed
23
## Quick start
Mark Otto's avatar
Mark Otto committed
24

25
Several quick start options are available:
26

Chris Rebert's avatar
Chris Rebert committed
27
- [Download the latest release](https://github.com/twbs/bootstrap/archive/v3.3.4.zip).
28
29
- Clone the repo: `git clone https://github.com/twbs/bootstrap.git`.
- Install with [Bower](http://bower.io): `bower install bootstrap`.
vsn4ik's avatar
vsn4ik committed
30
- Install with [npm](https://www.npmjs.com): `npm install bootstrap`.
31
32
- Install with [Meteor](https://www.meteor.com): `meteor add twbs:bootstrap`.
- Install with [Composer](https://getcomposer.org): `composer require twbs/bootstrap`.
Jacob Thornton's avatar
Jacob Thornton committed
33

Zlatan Vasović's avatar
Zlatan Vasović committed
34
Read the [Getting started page](http://getbootstrap.com/getting-started/) for information on the framework contents, templates and examples, and more.
35

36
37
38
39
40
41
42
43
### 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
vsn4ik's avatar
vsn4ik committed
44
│   ├── bootstrap.css.map
45
46
│   ├── bootstrap.min.css
│   ├── bootstrap-theme.css
vsn4ik's avatar
vsn4ik committed
47
│   ├── bootstrap-theme.css.map
48
49
50
51
52
53
54
55
│   └── bootstrap-theme.min.css
├── js/
│   ├── bootstrap.js
│   └── bootstrap.min.js
└── fonts/
    ├── glyphicons-halflings-regular.eot
    ├── glyphicons-halflings-regular.svg
    ├── glyphicons-halflings-regular.ttf
Bastien's avatar
Bastien committed
56
57
    ├── glyphicons-halflings-regular.woff
    └── glyphicons-halflings-regular.woff2
58
59
```

vsn4ik's avatar
vsn4ik committed
60
We provide compiled CSS and JS (`bootstrap.*`), as well as compiled and minified CSS and JS (`bootstrap.min.*`). CSS [source maps](https://developers.google.com/chrome-developer-tools/docs/css-preprocessors) (`bootstrap.*.map`) are available for use with certain browsers' developer tools. Fonts from Glyphicons are included, as is the optional Bootstrap theme.
61

Mark Otto's avatar
Mark Otto committed
62

Mark Otto's avatar
Mark Otto committed
63

Mark Otto's avatar
Mark Otto committed
64
## Bugs and feature requests
Mark Otto's avatar
Mark Otto committed
65

66
Have a bug or a feature request? Please first read the [issue guidelines](https://github.com/twbs/bootstrap/blob/master/CONTRIBUTING.md#using-the-issue-tracker) and search for existing and closed issues. If your problem or idea is not addressed yet, [please open a new issue](https://github.com/twbs/bootstrap/issues/new).
67
68


69
## Documentation
70

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

73
74
### Running documentation locally

XhmikosR's avatar
XhmikosR committed
75
1. If necessary, [install Jekyll](http://jekyllrb.com/docs/installation) (requires v2.5.x).
76
  - **Windows users:** Read [this unofficial guide](http://jekyll-windows.juthilo.com/) to get Jekyll up and running without problems.
77
2. Install the Ruby-based syntax highlighter, [Rouge](https://github.com/jneen/rouge), with `gem install rouge`.
Julian Thilo's avatar
Julian Thilo committed
78
79
3. From the root `/bootstrap` directory, run `jekyll serve` in the command line.
4. Open <http://localhost:9001> in your browser, and voilà.
80

Zlatan Vasović's avatar
Zlatan Vasović committed
81
Learn more about using Jekyll by reading its [documentation](http://jekyllrb.com/docs/home/).
82
83
84

### Documentation for previous releases

85
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.
86

87
[Previous releases](https://github.com/twbs/bootstrap/releases) and their documentation are also available for download.
88
89
90



Mark Otto's avatar
Mark Otto committed
91
92
## Contributing

93
Please read through our [contributing guidelines](https://github.com/twbs/bootstrap/blob/master/CONTRIBUTING.md). Included are directions for opening issues, coding standards, and notes on development.
94

95
Moreover, if your pull request contains JavaScript patches or features, you must include [relevant unit tests](https://github.com/twbs/bootstrap/tree/master/js/tests). All HTML and CSS should conform to the [Code Guide](https://github.com/mdo/code-guide), maintained by [Mark Otto](https://github.com/mdo).
Jacob Thornton's avatar
Jacob Thornton committed
96

97
Editor preferences are available in the [editor config](https://github.com/twbs/bootstrap/blob/master/.editorconfig) for easy use in common text editors. Read more and download plugins at <http://editorconfig.org>.
Mark Otto's avatar
Mark Otto committed
98

Jacob Thornton's avatar
Jacob Thornton committed
99

Mark Otto's avatar
Mark Otto committed
100

Mark Otto's avatar
Mark Otto committed
101
102
103
104
## Community

Keep track of development and community news.

105
- Follow [@getbootstrap on Twitter](https://twitter.com/getbootstrap).
106
- Read and subscribe to [The Official Bootstrap Blog](http://blog.getbootstrap.com).
Siecje's avatar
Siecje committed
107
- Chat with fellow Bootstrappers in IRC. On the `irc.freenode.net` server, in the `##bootstrap` channel.
108
- Implementation help may be found at Stack Overflow (tagged [`twitter-bootstrap-3`](http://stackoverflow.com/questions/tagged/twitter-bootstrap-3)).
Kevin Kirsche's avatar
Kevin Kirsche committed
109
- Developers should use the keyword `bootstrap` on packages which modify or add to the functionality of Bootstrap when distributing through [npm](https://www.npmjs.com/browse/keyword/bootstrap) or similar delivery mechanisms for maximum discoverability.
Mark Otto's avatar
Mark Otto committed
110
111
112
113
114



## Versioning

115
For transparency into our release cycle and in striving to maintain backward compatibility, Bootstrap is maintained under [the Semantic Versioning guidelines](http://semver.org/). Sometimes we screw up, but we'll adhere to those rules whenever possible.
Mark Otto's avatar
Mark Otto committed
116
117
118



Chris Rebert's avatar
Chris Rebert committed
119
## Creators
120

Mark Otto's avatar
Mark Otto committed
121
**Mark Otto**
Jacob Thornton's avatar
Jacob Thornton committed
122

123
124
- <https://twitter.com/mdo>
- <https://github.com/mdo>
125

Mark Otto's avatar
Mark Otto committed
126
**Jacob Thornton**
Jacob Thornton's avatar
Jacob Thornton committed
127

128
129
- <https://twitter.com/fat>
- <https://github.com/fat>
Mark Otto's avatar
Mark Otto committed
130

Mark Otto's avatar
Mark Otto committed
131

Mark Otto's avatar
Mark Otto committed
132

Mark Otto's avatar
Mark Otto committed
133
## Copyright and license
Jacob Thornton's avatar
Jacob Thornton committed
134

Zlatan Vasović's avatar
Zlatan Vasović committed
135
Code and documentation copyright 2011-2015 Twitter, Inc. Code released under [the MIT license](https://github.com/twbs/bootstrap/blob/master/LICENSE). Docs released under [Creative Commons](https://github.com/twbs/bootstrap/blob/master/docs/LICENSE).