getting-started.html 48.1 KB
Newer Older
Mark Otto's avatar
Mark Otto committed
1
2
---
layout: default
Mark Otto's avatar
Mark Otto committed
3
4
5
title: Getting started
slug: getting-started
lead: "An overview of Bootstrap, how to download and use, basic templates and examples, and more."
6
base_url: "../"
Mark Otto's avatar
Mark Otto committed
7
8
9
10
11
---


  <!-- Getting started
  ================================================== -->
Mark Otto's avatar
Mark Otto committed
12
  <div class="bs-docs-section">
Mark Otto's avatar
Mark Otto committed
13
    <div class="page-header">
Mark Otto's avatar
Mark Otto committed
14
      <h1 id="download">Download Bootstrap</h1>
Mark Otto's avatar
Mark Otto committed
15
    </div>
jody tate's avatar
jody tate committed
16
    <p class="lead">Bootstrap has a few easy ways to quickly get started, each one appealing to a different skill level and use case. Read through to see what suits your particular needs.</p>
Mark Otto's avatar
Mark Otto committed
17

Mark Otto's avatar
Mark Otto committed
18
    <h3 id="download-compiled">Compiled CSS, JS, and fonts</h3>
19
    <p>The fastest way to get Bootstrap is to download the precompiled and minified versions of our CSS, JavaScript, and fonts. No documentation or original source code files are included.</p>
20
    <p><a class="btn btn-lg btn-primary" href="{{ site.download_dist }}" onclick="_gaq.push(['_trackEvent', 'Getting started', 'Download', 'Download compiled']);" role="button">Download precompiled Bootstrap</a></p>
Mark Otto's avatar
Mark Otto committed
21

22
    <h3 id="download-additional">Additional downloads</h3>
Mark Otto's avatar
Mark Otto committed
23
24
    <div class="bs-docs-dl-options">
      <h4>
25
        <a href="{{ site.download_source }}" onclick="_gaq.push(['_trackEvent', 'Getting started', 'Download', 'Download source']);">Download source code</a>
Mark Otto's avatar
Mark Otto committed
26
      </h4>
27
      <p>Get the latest Bootstrap LESS and JavaScript source code by downloading it directly from GitHub.</p>
Mark Otto's avatar
Mark Otto committed
28
      <h4>
29
        <a href="{{ site.repo }}" onclick="_gaq.push(['_trackEvent', 'Getting started', 'Download', 'GitHub project']);">Clone or fork via GitHub</a>
Mark Otto's avatar
Mark Otto committed
30
      </h4>
31
      <p>Visit us on GitHub to clone or fork the Bootstrap project.</p>
Mark Otto's avatar
Mark Otto committed
32
      <h4>
Francis Brunelle's avatar
Francis Brunelle committed
33
        Install with <a href="http://bower.io">Bower</a>
Mark Otto's avatar
Mark Otto committed
34
      </h4>
35
      <p>Install and manage Bootstrap's styles, JavaScript, and documentation using <a href="http://bower.io">Bower</a>.</p>
Mark Otto's avatar
Mark Otto committed
36
37
38
      {% highlight bash %}$ bower install bootstrap{% endhighlight %}
    </div>

39
    <h3 id="download-cdn">Bootstrap CDN</h3>
40
    <p>The folks over at <a href="http://www.maxcdn.com/">MaxCDN</a> graciously provide CDN support for Bootstrap's CSS and JavaScript. Just use these <a href="http://www.bootstrapcdn.com/">Bootstrap CDN</a> links.</p>
Mark Otto's avatar
Mark Otto committed
41
{% highlight html %}
Mark Otto's avatar
Mark Otto committed
42
<!-- Latest compiled and minified CSS -->
Fabian Golle's avatar
Fabian Golle committed
43
<link rel="stylesheet" href="{{ site.cdn_css }}">
Mark Otto's avatar
Mark Otto committed
44

45
46
47
<!-- Optional theme -->
<link rel="stylesheet" href="{{ site.cdn_theme_css }}">

Mark Otto's avatar
Mark Otto committed
48
<!-- Latest compiled and minified JavaScript -->
Mark Otto's avatar
Mark Otto committed
49
<script src="{{ site.cdn_js }}"></script>
Mark Otto's avatar
Mark Otto committed
50
{% endhighlight %}
51

52
    <div class="bs-callout bs-callout-warning" id="callout-less-compilation">
53
      <h4>Compiling Bootstrap's LESS files</h4>
54
      <p>If you work with Bootstrap's uncompiled source code, you need to compile the LESS files to produce usable CSS files. For compiling LESS files into CSS, we only officially support <a href="http://twitter.github.io/recess/">Recess</a>, which is Twitter's CSS hinter based on <a href="http://lesscss.org">less.js</a>.</p>
55
    </div>
Mark Otto's avatar
Mark Otto committed
56
57
  </div>

Mark Otto's avatar
Mark Otto committed
58

Mark Otto's avatar
Mark Otto committed
59
60
  <!-- File structure
  ================================================== -->
Mark Otto's avatar
Mark Otto committed
61
  <div class="bs-docs-section">
Mark Otto's avatar
Mark Otto committed
62
    <div class="page-header">
Mark Otto's avatar
Mark Otto committed
63
      <h1 id="whats-included">What's included</h1>
Mark Otto's avatar
Mark Otto committed
64
    </div>
65
    <p class="lead">Within the download you'll find the following directories and files, logically grouping common resources and providing both compiled and minified variations.</p>
Mark Otto's avatar
Mark Otto committed
66
67
    <p>Once downloaded, unzip the compressed folder to see the structure of (the compiled) Bootstrap. You'll see something like this:</p>

68
69
<!-- NOTE: This info is intentionally duplicated in the README.
Copy any changes made here over to the README too. -->
Mark Otto's avatar
Mark Otto committed
70
{% highlight bash %}
Mark Otto's avatar
Mark Otto committed
71
72
73
74
bootstrap/
├── css/
│   ├── bootstrap.css
│   ├── bootstrap.min.css
Mark Otto's avatar
Mark Otto committed
75
│   ├── bootstrap-theme.css
76
│   └── bootstrap-theme.min.css
Mark Otto's avatar
Mark Otto committed
77
78
├── js/
│   ├── bootstrap.js
79
│   └── bootstrap.min.js
Mark Otto's avatar
Mark Otto committed
80
81
82
83
84
└── fonts/
    ├── glyphicons-halflings-regular.eot
    ├── glyphicons-halflings-regular.svg
    ├── glyphicons-halflings-regular.ttf
    └── glyphicons-halflings-regular.woff
Mark Otto's avatar
Mark Otto committed
85
86
{% endhighlight %}

87
    <p>This is the most basic form of Bootstrap: precompiled files for quick drop-in usage in nearly any web project. We provide compiled CSS and JS (<code>bootstrap.*</code>), as well as compiled and minified CSS and JS (<code>bootstrap.min.*</code>). Fonts from Glyphicons are included, as is the optional Bootstrap theme.</p>
88
    <div class="bs-callout bs-callout-danger" id="jquery-required">
Mark Otto's avatar
Mark Otto committed
89
      <h4>jQuery required</h4>
90
      <p>Please note that <strong>all JavaScript plugins require jQuery</strong> to be included, as shown in the <a href="#template">starter template</a>. <a href="{{ site.repo }}/blob/v{{ site.current_version }}/bower.json">Consult our <code>bower.json</code></a> to see which versions of jQuery are supported.</p>
Mark Otto's avatar
Mark Otto committed
91
92
93
    </div>
  </div>

94

95
  <!-- Template
Mark Otto's avatar
Mark Otto committed
96
  ================================================== -->
Mark Otto's avatar
Mark Otto committed
97
  <div class="bs-docs-section">
Mark Otto's avatar
Mark Otto committed
98
    <div class="page-header">
Mark Otto's avatar
Mark Otto committed
99
      <h1 id="template">Basic template</h1>
Mark Otto's avatar
Mark Otto committed
100
    </div>
101
    <p class="lead">Start with this basic HTML template, or modify <a href="../getting-started#examples">these examples</a>. We hope you'll customize our templates and examples, adapting them to suit your needs.</p>
Mark Otto's avatar
Mark Otto committed
102

103
    <p>Copy the HTML below to begin working with a minimal Bootstrap document.</p>
Mark Otto's avatar
Mark Otto committed
104
105
106
107
108
109
110
{% highlight html %}
<!DOCTYPE html>
<html>
  <head>
    <title>Bootstrap 101 Template</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <!-- Bootstrap -->
Julian Thilo's avatar
Julian Thilo committed
111
    <link href="css/bootstrap.min.css" rel="stylesheet">
112

113
114
    <!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
    <!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
115
    <!--[if lt IE 9]>
Chris Rebert's avatar
Chris Rebert committed
116
      <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
117
      <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
118
    <![endif]-->
Mark Otto's avatar
Mark Otto committed
119
120
121
122
  </head>
  <body>
    <h1>Hello, world!</h1>

Chris Rebert's avatar
Chris Rebert committed
123
    <!-- jQuery (necessary for Bootstrap's JavaScript plugins) -->
Chris Rebert's avatar
Chris Rebert committed
124
    <script src="https://code.jquery.com/jquery.js"></script>
Mark Otto's avatar
Mark Otto committed
125
126
127
128
129
130
131
132
    <!-- Include all compiled plugins (below), or include individual files as needed -->
    <script src="js/bootstrap.min.js"></script>
  </body>
</html>
{% endhighlight %}
  </div>


133
134
135
136
137
138
  <!-- Template
  ================================================== -->
  <div class="bs-docs-section">
    <div class="page-header">
      <h1 id="examples">Examples</h1>
    </div>
139
    <p class="lead">Build on the basic template above with Bootstrap's many components. See also <a href="#customizing">Customizing Bootstrap</a> for tips on maintaining your own Bootstrap variants.</p>
140

141
    <div class="row bs-examples">
142
      <div class="col-xs-6 col-md-4">
143
144
        <a class="thumbnail" href="../examples/starter-template/">
          <img src="../examples/screenshots/starter-template.jpg" alt="">
145
        </a>
146
147
        <h4>Starter template</h4>
        <p>Nothing but the basics: compiled CSS and JavaScript along with a container.</p>
148
149
      </div>
      <div class="col-xs-6 col-md-4">
150
151
        <a class="thumbnail" href="../examples/grid/">
          <img src="../examples/screenshots/grid.jpg" alt="">
152
        </a>
153
154
        <h4>Grids</h4>
        <p>Multiple examples of grid layouts with all four tiers, nesting, and more.</p>
155
156
157
158
      </div>
      <div class="clearfix visible-xs"></div>

      <div class="col-xs-6 col-md-4">
159
160
        <a class="thumbnail" href="../examples/jumbotron/">
          <img src="../examples/screenshots/jumbotron.jpg" alt="">
161
        </a>
162
163
        <h4>Jumbotron</h4>
        <p>Build around the jumbotron with a navbar and some basic grid columns.</p>
164
165
      </div>
      <div class="col-xs-6 col-md-4">
166
167
        <a class="thumbnail" href="../examples/jumbotron-narrow/">
          <img src="../examples/screenshots/jumbotron-narrow.jpg" alt="">
168
        </a>
169
170
        <h4>Narrow jumbotron</h4>
        <p>Build a more custom page by narrowing the default container and jumbotron.</p>
171
172
173
174
      </div>
      <div class="clearfix visible-xs"></div>

      <div class="col-xs-6 col-md-4">
175
176
        <a class="thumbnail" href="../examples/navbar/">
          <img src="../examples/screenshots/navbar.jpg" alt="">
177
        </a>
178
179
        <h4>Navbar</h4>
        <p>Super basic template that includes the navbar along with some additional content.</p>
180
181
      </div>
      <div class="col-xs-6 col-md-4">
182
183
        <a class="thumbnail" href="../examples/navbar-static-top/">
          <img src="../examples/screenshots/navbar-static.jpg" alt="">
184
        </a>
185
186
        <h4>Static top navbar</h4>
        <p>Super basic template with a static top navbar along with some additional content.</p>
187
188
189
190
      </div>
      <div class="clearfix visible-xs"></div>

      <div class="col-xs-6 col-md-4">
191
192
        <a class="thumbnail" href="../examples/navbar-fixed-top/">
          <img src="../examples/screenshots/navbar-fixed.jpg" alt="">
193
        </a>
194
195
        <h4>Fixed navbar</h4>
        <p>Super basic template with a fixed top navbar along with some additional content.</p>
196
197
      </div>
      <div class="col-xs-6 col-md-4">
198
199
        <a class="thumbnail" href="../examples/signin/">
          <img src="../examples/screenshots/sign-in.jpg" alt="">
200
        </a>
201
202
        <h4>Sign-in page</h4>
        <p>Custom form layout and design for a simple sign in form.</p>
203
204
205
206
      </div>
      <div class="clearfix visible-xs"></div>

      <div class="col-xs-6 col-md-4">
207
208
        <a class="thumbnail" href="../examples/sticky-footer/">
          <img src="../examples/screenshots/sticky-footer.jpg" alt="">
209
        </a>
210
211
        <h4>Sticky footer</h4>
        <p>Attach a footer to the bottom of the viewport when the content is shorter than it.</p>
212
213
      </div>
      <div class="col-xs-6 col-md-4">
214
215
        <a class="thumbnail" href="../examples/sticky-footer-navbar/">
          <img src="../examples/screenshots/sticky-footer-navbar.jpg" alt="">
216
        </a>
217
        <h4>Sticky footer with navbar</h4>
Mark Otto's avatar
Mark Otto committed
218
        <p>Attach a footer to the bottom of the viewport with a fixed navbar at the top.</p>
219
220
221
      </div>
      <div class="clearfix visible-xs"></div>

Mark Otto's avatar
Mark Otto committed
222
223
224
225
226
      <div class="col-xs-6 col-md-4">
        <a class="thumbnail" href="../examples/justified-nav/">
          <img src="../examples/screenshots/justified-nav.jpg" alt="">
        </a>
        <h4>Justified nav</h4>
Mark Otto's avatar
Mark Otto committed
227
        <p>Create a custom navbar with justified links. Heads up! <a href="../components/#nav-justified">Not too WebKit friendly.</a></p>
Mark Otto's avatar
Mark Otto committed
228
      </div>
229
      <div class="col-xs-6 col-md-4">
230
231
        <a class="thumbnail" href="../examples/offcanvas/">
          <img src="../examples/screenshots/offcanvas.jpg" alt="">
232
        </a>
233
234
        <h4>Offcanvas</h4>
        <p>Build a toggleable off-canvas navigation menu for use with Bootstrap.</p>
235
      </div>
Mark Otto's avatar
Mark Otto committed
236
237
      <div class="clearfix visible-xs"></div>

238
      <div class="col-xs-6 col-md-4">
239
240
        <a class="thumbnail" href="../examples/carousel/">
          <img src="../examples/screenshots/carousel.jpg" alt="">
241
        </a>
242
243
        <h4>Carousel</h4>
        <p>Customize the navbar and carousel, then add some new components.</p>
244
      </div>
245
246
247
248
249
250
251
      <div class="col-xs-6 col-md-4">
        <a class="thumbnail" href="../examples/non-responsive/">
          <img src="../examples/screenshots/non-responsive.jpg" alt="">
        </a>
        <h4>Non-responsive Bootstrap</h4>
        <p>Easily disable the responsiveness of Bootstrap <a href="../getting-started/#disable-responsive">per our docs</a>.</p>
      </div>
252
      <div class="clearfix visible-xs"></div>
253

254
255
256
257
258
259
260
      <div class="col-xs-6 col-md-4">
        <a class="thumbnail" href="../examples/theme/">
          <img src="../examples/screenshots/theme.jpg" alt="">
        </a>
        <h4>Bootstrap theme</h4>
        <p>Load the optional Bootstrap theme for a visually enhanced experience.</p>
      </div>
261
262
263
264
265
    </div>

  </div>


266
267
268
269
270
271
  <!-- Template
  ================================================== -->
  <div class="bs-docs-section">
    <div class="page-header">
      <h1 id="disable-responsive">Disabling responsiveness</h1>
    </div>
272
    <p class="lead">Bootstrap automatically adapts your pages for various screen sizes.
273
      Here's how to disable this feature so your page works like in <a href="../examples/non-responsive/">this non-responsive example</a>.</p>
274

275
    <h3>Steps to disable page responsiveness</h3>
276
    <ol>
277
      <li>Omit the viewport <code>&lt;meta&gt;</code> mentioned in <a href="../css/#overview-mobile">the CSS docs</a></li>
278
      <li>Override the <code>width</code> on the <code>.container</code> for each grid tier with a single width, for example <code>width: 970px !important;</code> Be sure that this comes after the default Bootstrap CSS. You can optionally avoid the <code>!important</code> with media queries or some selector-fu.</li>
279
      <li>If using navbars, remove all navbar collapsing and expanding behavior.</li>
280
      <li>For grid layouts, use <code>.col-xs-*</code> classes in addition to, or in place of, the medium/large ones. Don't worry, the extra-small device grid scales to all resolutions.</li>
281
    </ol>
282
    <p>You'll still need Respond.js for IE8 (since our media queries are still there and need to be processed).
283
      This disables the "mobile site" aspects of Bootstrap.</p>
284

285
286
    <h3>Bootstrap template with responsiveness disabled</h3>
    <p>We've applied these steps to an example. Read its source code to see the specific changes implemented.</p>
287
288
289
    <p>
      <a href="../examples/non-responsive/" class="btn btn-primary">View non-responsive example</a>
    </p>
290
291
292
  </div>


iatek's avatar
iatek committed
293
294
295
296
  <!-- Migration
  ================================================== -->
  <div class="bs-docs-section">
    <div class="page-header">
297
      <h1 id="migration">Migrating from 2.x to 3.0</h1>
iatek's avatar
iatek committed
298
    </div>
299
    <p class="lead">Bootstrap 3 is not backwards compatible with v2.x. Use this section as a general guide to upgrading from v2.x to v3.0. For a broader overview, see <a href="http://blog.getbootstrap.com/2013/08/19/bootstrap-3-released/">what's new</a> in the v3.0 release announcement.</p>
Mark Otto's avatar
Mark Otto committed
300
301

    <h2 id="migration-classes">Major class changes</h2>
302
    <p>This table shows the style changes between v2.x and v3.0.</p>
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
    <div class="table-responsive">
      <table class="table table-bordered table-striped">
        <thead>
          <tr>
            <th>Bootstrap 2.x</th>
            <th>Bootstrap 3.0</th>
          </tr>
        </thead>
        <tbody>
          <tr>
            <td><code>.container-fluid</code></td>
            <td><code>.container</code></td>
          </tr>
          <tr>
            <td><code>.row-fluid</code></td>
            <td><code>.row</code></td>
          </tr>
          <tr>
            <td><code>.span*</code></td>
            <td><code>.col-md-*</code></td>
          </tr>
          <tr>
            <td><code>.offset*</code></td>
            <td><code>.col-md-offset-*</code></td>
          </tr>
          <tr>
            <td><code>.brand</code></td>
            <td><code>.navbar-brand</code></td>
          </tr>
Mark Otto's avatar
Mark Otto committed
332
333
334
335
336
337
338
339
340
341
342
343
          <tr>
            <td><code>.nav-collapse</code></td>
            <td><code>.navbar-collapse</code></td>
          </tr>
          <tr>
            <td><code>.nav-toggle</code></td>
            <td><code>.navbar-toggle</code></td>
          </tr>
          <tr>
            <td><code>.btn-navbar</code></td>
            <td><code>.navbar-btn</code></td>
          </tr>
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
          <tr>
            <td><code>.hero-unit</code></td>
            <td><code>.jumbotron</code></td>
          </tr>
          <tr>
            <td><code>.icon-*</code></td>
            <td><code>.glyphicon .glyphicon-*</code></td>
          </tr>
          <tr>
            <td><code>.btn</code></td>
            <td><code>.btn .btn-default</code></td>
          </tr>
          <tr>
            <td><code>.btn-mini</code></td>
            <td><code>.btn-xs</code></td>
          </tr>
          <tr>
            <td><code>.btn-small</code></td>
            <td><code>.btn-sm</code></td>
          </tr>
          <tr>
            <td><code>.btn-large</code></td>
            <td><code>.btn-lg</code></td>
          </tr>
Chris Rebert's avatar
Chris Rebert committed
368
369
370
371
          <tr>
            <td><code>.alert-error</code></td>
            <td><code>.alert-danger</code></td>
          </tr>
372
373
          <tr>
            <td><code>.visible-phone</code></td>
374
            <td><code>.visible-xs</code></td>
375
376
377
          </tr>
          <tr>
            <td><code>.visible-tablet</code></td>
378
            <td><code>.visible-sm</code></td>
379
380
381
          </tr>
          <tr>
            <td><code>.visible-desktop</code></td>
382
            <td><code>.visible-md</code></td>
383
384
385
          </tr>
          <tr>
            <td><code>.hidden-phone</code></td>
386
            <td><code>.hidden-xs</code></td>
387
388
389
          </tr>
          <tr>
            <td><code>.hidden-tablet</code></td>
390
            <td><code>.hidden-sm</code></td>
391
392
393
          </tr>
          <tr>
            <td><code>.hidden-desktop</code></td>
394
            <td><code>.hidden-md</code></td>
395
396
397
398
399
400
401
402
403
          </tr>
          <tr>
            <td><code>.input-small</code></td>
            <td><code>.input-sm</code></td>
          </tr>
          <tr>
            <td><code>.input-large</code></td>
            <td><code>.input-lg</code></td>
          </tr>
404
405
406
407
          <tr>
            <td><code>.control-group</code></td>
            <td><code>.form-group</code></td>
          </tr>
408
          <tr>
Mark Otto's avatar
Mark Otto committed
409
410
            <td><code>.checkbox.inline</code> <code>.radio.inline</code></td>
            <td><code>.checkbox-inline</code> <code>.radio-inline</code></td>
411
412
          </tr>
          <tr>
Mark Otto's avatar
Mark Otto committed
413
            <td><code>.input-prepend</code> <code>.input-append</code></td>
414
415
416
417
418
419
420
            <td><code>.input-group</code></td>
          </tr>
          <tr>
            <td><code>.add-on</code></td>
            <td><code>.input-group-addon</code></td>
          </tr>
          <tr>
421
            <td><code>.img-polaroid</code></td>
422
423
            <td><code>.img-thumbnail</code></td>
          </tr>
Mark Otto's avatar
Mark Otto committed
424
425
426
427
          <tr>
            <td><code>ul.unstyled</code></td>
            <td><code>.list-unstyled</code></td>
          </tr>
428
429
430
431
          <tr>
            <td><code>ul.inline</code></td>
            <td><code>.list-inline</code></td>
          </tr>
432
433
434
435
          <tr>
            <td><code>.muted</code></td>
            <td><code>.text-muted</code></td>
          </tr>
Chris Rebert's avatar
Chris Rebert committed
436
437
438
439
          <tr>
            <td><code>.text-error</code></td>
            <td><code>.text-danger</code></td>
          </tr>
440
441
442
443
          <tr>
            <td><code>.table .error</code></td>
            <td><code>.table .danger</code></td>
          </tr>
444
          <tr>
Chris Rebert's avatar
Chris Rebert committed
445
446
447
448
449
450
            <td><code>.bar</code></td>
            <td><code>.progress-bar</code></td>
          </tr>
          <tr>
            <td><code>.bar-*</code></td>
            <td><code>.progress-bar-*</code></td>
451
          </tr>
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
          <tr>
            <td><code>.accordion</code></td>
            <td><code>.panel-group</code></td>
          </tr>
          <tr>
            <td><code>.accordion-group</code></td>
            <td><code>.panel .panel-default</code></td>
          </tr>
          <tr>
            <td><code>.accordion-heading</code></td>
            <td><code>.panel-heading</code></td>
          </tr>
          <tr>
            <td><code>.accordion-body</code></td>
            <td><code>.panel-collapse</code></td>
          </tr>
          <tr>
            <td><code>.accordion-inner</code></td>
            <td><code>.panel-body</code></td>
          </tr>
        </tbody>
      </table>
    </div><!-- /.table-responsive -->
475

Mark Otto's avatar
Mark Otto committed
476
    <h2 id="migration-new">What's new</h2>
477
    <p>We've added new elements and changed some existing ones. Here are the new or updated styles.</p>
478
479
480
481
482
483
484
485
486
487
488
    <div class="table-responsive">
      <table class="table table-bordered table-striped">
        <thead>
          <tr>
            <th>Element</th>
            <th>Description</th>
          </tr>
        </thead>
        <tbody>
          <tr>
            <td>Panels</td>
Mark Otto's avatar
Mark Otto committed
489
            <td><code>.panel .panel-default</code> <code>.panel-body</code> <code>.panel-title</code> <code>.panel-heading</code> <code>.panel-footer</code> <code>.panel-collapse</code></td>
490
491
492
493
494
495
496
497
498
499
500
501
502
503
          </tr>
          <tr>
            <td>List groups</td>
            <td><code>.list-group</code> <code>.list-group-item</code> <code>.list-group-item-text</code> <code>.list-group-item-heading</code></td>
          </tr>
          <tr>
            <td>Glyphicons</td>
            <td><code>.glyphicon</code></td>
          </tr>
          <tr>
            <td>Jumbotron</td>
            <td><code>.jumbotron</code></td>
          </tr>
          <tr>
504
            <td>Extra small grid (&lt;768px)</td>
505
506
507
            <td><code>.col-xs-*</code></td>
          </tr>
          <tr>
508
            <td>Small grid (&ge;768px)</td>
509
510
511
            <td><code>.col-sm-*</code></td>
          </tr>
          <tr>
512
            <td>Medium grid (&ge;992px)</td>
513
514
515
            <td><code>.col-md-*</code></td>
          </tr>
          <tr>
516
            <td>Large grid (&ge;1200px)</td>
517
518
            <td><code>.col-lg-*</code></td>
          </tr>
519
520
521
522
          <tr>
            <td>Responsive utility classes (&ge;1200px)</td>
            <td><code>.visible-lg</code> <code>.hidden-lg</code></td>
          </tr>
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
          <tr>
            <td>Offsets</td>
            <td><code>.col-sm-offset-*</code> <code>.col-md-offset-*</code> <code>.col-lg-offset-*</code></td>
          </tr>
          <tr>
            <td>Push</td>
            <td><code>.col-sm-push-*</code> <code>.col-md-push-*</code> <code>.col-lg-push-*</code></td>
          </tr>
          <tr>
            <td>Pull</td>
            <td><code>.col-sm-pull-*</code> <code>.col-md-pull-*</code> <code>.col-lg-pull-*</code></td>
          </tr>
          <tr>
            <td>Input groups</td>
            <td><code>.input-group</code> <code>.input-group-addon</code> <code>.input-group-btn</code></td>
          </tr>
          <tr>
            <td>Form controls</td>
            <td><code>.form-control</code> <code>.form-group</code></td>
          </tr>
          <tr>
            <td>Button group sizes</td>
            <td><code>.btn-group-xs</code> <code>.btn-group-sm</code> <code>.btn-group-lg</code></td>
          </tr>
          <tr>
            <td>Navbar text</td>
            <td><code>.navbar-text</code></td>
          </tr>
          <tr>
            <td>Navbar header</td>
            <td><code>.navbar-header</code></td>
          </tr>
          <tr>
            <td>Justified tabs / pills</td>
            <td><code>.nav-justified</code></td>
          </tr>
          <tr>
            <td>Responsive images</td>
            <td><code>.img-responsive</code></td>
          </tr>
          <tr>
            <td>Contextual table rows</td>
            <td><code>.success</code> <code>.danger</code> <code>.warning</code> <code>.active</code></td>
          </tr>
          <tr>
            <td>Contextual panels</td>
            <td><code>.panel-success</code> <code>.panel-danger</code> <code>.panel-warning</code> <code>.panel-info</code></td>
          </tr>
          <tr>
            <td>Modal</td>
            <td><code>.modal-dialog</code> <code>.modal-content</code></td>
          </tr>
          <tr>
            <td>Thumbnail image</td>
            <td><code>.img-thumbnail</code></td>
          </tr>
          <tr>
            <td>Well sizes</td>
            <td><code>.well-sm</code> <code>.well-lg</code></td>
          </tr>
          <tr>
            <td>Alert links</td>
            <td><code>.alert-link</code></td>
          </tr>
        </tbody>
      </table>
    </div><!-- /.table-responsive -->

Mark Otto's avatar
Mark Otto committed
591

Mark Otto's avatar
Mark Otto committed
592
    <h2 id="migration-dropped">What's removed</h2>
593
    <p>The following elements have been dropped or changed in v3.0.</p>
594
595
596
597
598
599
600
601
602
603
604
605
606
    <div class="table-responsive">
      <table class="table table-bordered table-striped">
        <thead>
          <tr>
            <th>Element</th>
            <th>Removed from 2.x</th>
            <th>3.0 Equivalent</th>
          </tr>
        </thead>
        <tbody>
          <tr>
            <td>Form actions</td>
            <td><code>.form-actions</code></td>
Mark Otto's avatar
Mark Otto committed
607
            <td class="text-muted">N/A</td>
608
609
          </tr>
          <tr>
Mark Otto's avatar
Mark Otto committed
610
611
            <td>Search form</td>
            <td><code>.form-search</code></td>
Mark Otto's avatar
Mark Otto committed
612
            <td class="text-muted">N/A</td>
613
614
615
616
617
618
619
620
621
622
623
          </tr>
          <tr>
            <td>Fluid container</td>
            <td><code>.container-fluid</code></td>
            <td><code>.container</code> (no more fixed grid)</td>
          </tr>
          <tr>
            <td>Fluid row</td>
            <td><code>.row-fluid</code></td>
            <td><code>.row</code> (no more fixed grid)</td>
          </tr>
624
625
626
627
628
629
630
631
632
633
          <tr>
            <td>Controls wrapper</td>
            <td><code>.controls</code></td>
            <td class="text-muted">N/A</td>
          </tr>
          <tr>
            <td>Controls row</td>
            <td><code>.controls-row</code></td>
            <td><code>.row</code> or <code>.form-group</code></td>
          </tr>
634
635
636
          <tr>
            <td>Navbar inner</td>
            <td><code>.navbar-inner</code></td>
Mark Otto's avatar
Mark Otto committed
637
            <td class="text-muted">N/A</td>
638
          </tr>
639
640
641
642
643
          <tr>
            <td>Navbar vertical dividers</td>
            <td><code>.navbar .divider-vertical</code></td>
            <td class="text-muted">N/A</td>
          </tr>
644
645
646
          <tr>
            <td>Dropdown submenu</td>
            <td><code>.dropdown-submenu</code></td>
Mark Otto's avatar
Mark Otto committed
647
            <td class="text-muted">N/A</td>
648
649
650
651
          </tr>
          <tr>
            <td>Tab alignments</td>
            <td><code>.tabs-left</code> <code>.tabs-right</code> <code>.tabs-below</code></td>
Mark Otto's avatar
Mark Otto committed
652
            <td class="text-muted">N/A</td>
653
          </tr>
654
655
656
          <tr>
            <td>Nav lists</td>
            <td><code>.nav-list</code> <code>.nav-header</code></td>
657
            <td>No direct equivalent, but <a href="../components/#list-group">list groups</a> and <a href="../javascript/#collapse"><code>.panel-group</code>s</a> are similar.</td>
658
          </tr>
659
660
661
662
        </tbody>
      </table>
    </div><!-- /.table-responsive -->

Mark Otto's avatar
Mark Otto committed
663

Mark Otto's avatar
Mark Otto committed
664
    <h2 id="migration-notes">Additional notes</h2>
665
    <p>Other changes in v3.0 are not immediately apparent. Base classes, key styles, and behaviors have been adjusted for flexibility and our <em>mobile first</em> approach. Here's a partial list:</p>
Mark Otto's avatar
Mark Otto committed
666
    <ul>
667
668
      <li>By default, text-based form controls now receive only minimal styling.  For focus colors and rounded corners, apply the <code>.form-control</code> class on the element to style.</li>
      <li>Text-based form controls with the <code>.form-control</code> class applied are now 100% wide by default. Wrap inputs inside <code>&lt;div class="col-*"&gt;&lt;/div&gt;</code> to control input widths.</li>
Mark Otto's avatar
Mark Otto committed
669
670
671
672
      <li><code>.badge</code> no longer has contextual (-success,-primary,etc..) classes.</li>
      <li><code>.btn</code> must also use <code>.btn-default</code> to get the "default" button.</li>
      <li><code>.container</code> and <code>.row</code> are now fluid (percentage-based).</li>
      <li>Images are no longer responsive by default. Use <code>.img-responsive</code> for fluid <code>&lt;img&gt;</code> size.</li>
673
      <li>The icons, now <code>.glyphicon</code>, are now font based. Icons also require a base and icon class (e.g. <code>.glyphicon .glyphicon-asterisk</code>).</li>
Mark Otto's avatar
Mark Otto committed
674
      <li>Typeahead has been dropped, in favor of using <a href="http://twitter.github.io/typeahead.js/">Twitter Typeahead</a>.</li>
675
      <li>Modal markup has changed significantly. The <code>.modal-header</code>, <code>.modal-body</code>, and <code>.modal-footer</code> sections are now wrapped in <code>.modal-content</code> and <code>.modal-dialog</code> for better mobile styling and behavior.</li>
676
      <li>The HTML loaded by the <code>remote</code> modal option is now injected into the <code>.modal</code> instead of into the <code>.modal-body</code>. This allows you to also easily vary the header and footer of the modal, not just the modal body.</li>
Mark Otto's avatar
Mark Otto committed
677
      <li>JavaScript events are namespaced. For example, to handle the modal "show" event, use <code>'show.bs.modal'</code>. For tabs "shown" use <code>'shown.bs.tab'</code>, etc..</li>
Mark Otto's avatar
Mark Otto committed
678
    </ul>
679
    <p>For more information on upgrading to v3.0, and code snippets from the community, see <a href="http://bootply.com/">Bootply</a>.</p>
iatek's avatar
iatek committed
680
  </div>
681
682


683
  <!-- Browser support
684
  ================================================== -->
Mark Otto's avatar
Mark Otto committed
685
  <div class="bs-docs-section">
686
    <div class="page-header">
687
      <h1 id="browsers">Browser support</h1>
688
    </div>
689
    <p class="lead">Bootstrap is built to work best in the latest desktop and mobile browsers, meaning older browsers might display differently styled, though fully functional, renderings of certain components.</p>
690

691
    <h3>Supported browsers</h3>
692
693
694
    <p>Specifically, we support the latest versions of the following:</p>
    <ul>
      <li>Chrome (Mac, Windows, iOS, and Android)</li>
695
      <li>Safari (Mac and iOS only, as the Windows version is being abandoned)</li>
696
697
698
699
      <li>Firefox (Mac, Windows)</li>
      <li>Internet Explorer</li>
      <li>Opera (Mac, Windows)</li>
    </ul>
Zlatan Vasović's avatar
Zlatan Vasović committed
700
    <p>Unofficially, Bootstrap should look and behave well enough in Chromium and Chrome for Linux, Firefox for Linux, and Internet Explorer 7, though they are not officially supported.</p>
701
702

    <h3>Internet Explorer 8 and 9</h3>
Chris Rebert's avatar
Chris Rebert committed
703
    <p>Internet Explorer 8 and 9 are also supported, however, please be aware that some CSS3 properties and HTML5 elements are not fully supported by these browsers. In addition, <strong>Internet Explorer 8 requires the use of <a href="https://github.com/scottjehl/Respond">Respond.js</a> to enable media query support.</strong></p>
704
705
706
707
    <div class="table-responsive">
      <table class="table table-bordered table-striped">
        <thead>
          <tr>
708
709
710
            <th scope="col" class="col-xs-4">Feature</th>
            <th scope="col" class="col-xs-4">Internet Explorer 8</th>
            <th scope="col" class="col-xs-4">Internet Explorer 9</th>
711
712
713
714
          </tr>
        </thead>
        <tbody>
          <tr>
715
            <th scope="row"><code>border-radius</code></th>
716
717
            <td class="text-danger"><span class="glyphicon glyphicon-remove"></span> Not supported</td>
            <td class="text-success"><span class="glyphicon glyphicon-ok"></span> Supported</td>
718
719
          </tr>
          <tr>
720
            <th scope="row"><code>box-shadow</code></th>
721
722
            <td class="text-danger"><span class="glyphicon glyphicon-remove"></span> Not supported</td>
            <td class="text-success"><span class="glyphicon glyphicon-ok"></span> Supported</td>
723
724
          </tr>
          <tr>
725
            <th scope="row"><code>transform</code></th>
726
727
            <td class="text-danger"><span class="glyphicon glyphicon-remove"></span> Not supported</td>
            <td class="text-success"><span class="glyphicon glyphicon-ok"></span> Supported, with <code>-ms</code> prefix</td>
728
729
          </tr>
          <tr>
730
            <th scope="row"><code>transition</code></th>
731
            <td colspan="2" class="text-danger"><span class="glyphicon glyphicon-remove"></span> Not supported</td>
732
733
734
735
          </tr>
        </tbody>
        <tbody>
          <tr>
736
            <th scope="row"><code>placeholder</code></th>
737
            <td colspan="2" class="text-danger"><span class="glyphicon glyphicon-remove"></span> Not supported</td>
738
739
740
741
742
          </tr>
        </tbody>
      </table>
    </div>

Chris Rebert's avatar
Chris Rebert committed
743
    <p>Visit <a href="http://caniuse.com/">Can I use...</a> for details on browser support of CSS3 and HTML5 features.</p>
744

Mark Otto's avatar
Mark Otto committed
745
    <h3>Internet Explorer 8 and Respond.js</h3>
Mark Otto's avatar
edit    
Mark Otto committed
746
    <p>Beware of the following caveats when using Respond.js in your development and production environments for Internet Explorer 8.</p>
Mark Otto's avatar
Mark Otto committed
747
    <h4 id="respond-js-x-domain">Respond.js and cross-domain CSS</h4>
Mark Otto's avatar
Mark Otto committed
748
    <p>Using Respond.js with CSS hosted on a different (sub)domain (for example, on a CDN) requires some additional setup. <a href="https://github.com/scottjehl/Respond/blob/master/README.md#cdnx-domain-setup">See the Respond.js docs</a> for details.</p>
Mark Otto's avatar
Mark Otto committed
749
    <h4 id="respond-file-proto">Respond.js and <code>file://</code></h4>
Mark Otto's avatar
Mark Otto committed
750
    <p>Due to browser security rules, Respond.js doesn't work with pages viewed via the <code>file://</code> protocol (like when opening a local HTML file). To test responsive features in IE8, view your pages over HTTP(S). <a href="https://github.com/scottjehl/Respond/blob/master/README.md#support--caveats">See the Respond.js docs</a> for details.</p>
Mark Otto's avatar
Mark Otto committed
751
    <h4 id="respond-import">Respond.js and <code>@import</code></h4>
Mark Otto's avatar
Mark Otto committed
752
753
    <p>Respond.js doesn't work with CSS that's referenced via <code>@import</code>. In particular, some Drupal configurations are known to use <code>@import</code>. <a href="https://github.com/scottjehl/Respond/blob/master/README.md#support--caveats">See the Respond.js docs</a> for details.</p>

754
    <h3>Internet Explorer 8 and box-sizing</h3>
755
    <p>IE8 does not fully support <code>box-sizing: border-box;</code> when combined with <code>min-width</code>, <code>max-width</code>, <code>min-height</code>, or <code>max-height</code>. For that reason, as of v3.0.1, we no longer use <code>max-width</code> on <code>.container</code>s.</p>
756

757
    <h3 id="ie-compat-modes">IE Compatibility modes</h3>
Chris Rebert's avatar
Chris Rebert committed
758
    <p>Bootstrap is not supported in the old Internet Explorer compatibility modes. To be sure you're using the latest rendering mode for IE, consider including the appropriate <code>&lt;meta&gt;</code> tag in your pages:</p>
Mark Otto's avatar
Mark Otto committed
759
760
761
{% highlight html %}
<meta http-equiv="X-UA-Compatible" content="IE=edge">
{% endhighlight %}
762
    <p>This tag is included in all docs pages and examples to ensure the best rendering possible in each supported version of Internet Explorer.</p>
Mark Otto's avatar
Mark Otto committed
763
    <p>See <a href="http://stackoverflow.com/questions/6771258/whats-the-difference-if-meta-http-equiv-x-ua-compatible-content-ie-edge">this StackOverflow question</a> for more information.</p>
764

765
    <h3 id="ie-10-width">Internet Explorer 10 in Windows 8 and Windows Phone 8</h3>
766
767
768
769
770
    <p>Internet Explorer 10 doesn't differentiate <strong>device width</strong> from <strong>viewport width</strong>, and thus doesn't properly apply the media queries in Bootstrap's CSS. Normally you'd just add a quick snippet of CSS to fix this:</p>
{% highlight css %}
@-ms-viewport       { width: device-width; }
{% endhighlight %}
    <p>However, this doesn't work as it causes Windows Phone 8 devices to show a mostly desktop view instead of narrow "phone" view. To address this, you'll need to <strong>include the following CSS and JavaScript to work around the bug until Microsoft issues a fix</strong>.</p>
771
772
773
774
775
776
777
778
779
780
{% highlight css %}
@-webkit-viewport   { width: device-width; }
@-moz-viewport      { width: device-width; }
@-ms-viewport       { width: device-width; }
@-o-viewport        { width: device-width; }
@viewport           { width: device-width; }
{% endhighlight %}

{% highlight js %}
if (navigator.userAgent.match(/IEMobile\/10\.0/)) {
Chris Rebert's avatar
Chris Rebert committed
781
  var msViewportStyle = document.createElement("style")
782
783
784
785
  msViewportStyle.appendChild(
    document.createTextNode(
      "@-ms-viewport{width:auto!important}"
    )
Chris Rebert's avatar
Chris Rebert committed
786
787
  )
  document.getElementsByTagName("head")[0].appendChild(msViewportStyle)
788
789
}
{% endhighlight %}
Mark Otto's avatar
Mark Otto committed
790
    <p>For more information and usage guidelines, read <a href="http://timkadlec.com/2013/01/windows-phone-8-and-device-width/">Windows Phone 8 and Device-Width</a>.</p>
791
    <p>As a heads up, we include this in the Bootstrap docs as an example.</p>
792

793
    <h3 id="safari-percentages">Safari percent rounding</h3>
794
    <p>As of Safari v6.1 for OS X and Safari for iOS v7.0.1, Safari's rendering engine has some trouble with the number of decimal places used in our <code>.col-*-1</code> grid classes. So if you have 12 individual grid columns, you'll notice that they come up short compared to other rows of columns. We can't do much here (<a href="https://github.com/twbs/bootstrap/issues/9282">see #9282</a>) but you do have some options:</p>
795
796
    <ul>
      <li>Add <code>.pull-right</code> to your last grid column to get the hard-right alignment</li>
Mark Otto's avatar
Mark Otto committed
797
      <li>Tweak your percentages manually to get the perfect rounding for Safari (more difficult than the first option)</li>
798
799
    </ul>
    <p>We'll keep an eye on this though and update our code if we have an easy solution.</p>
800

801
    <h3 id="mobile-modals">Modals and mobile devices</h3>
802
    <h4>Overflow and scrolling</h4>
803
    <p>Support for <code>overflow: hidden</code> on the <code>&lt;body&gt;</code> element is quite limited in iOS and Android. To that end, when you scroll past the top or bottom of a modal in either of those devices' browsers, the <code>&lt;body&gt;</code> content will begin to scroll.</p>
804
    <h4>Virtual keyboards</h4>
805
    <p>Also, note that if you're using inputs in your modal – iOS has a rendering bug that doesn't update the position of fixed elements when the virtual keyboard is triggered. A few workarounds for this include transforming your elements to <code>position: absolute</code> or invoking a timer on focus to try to correct the positioning manually. This is not handled by Bootstrap, so it is up to you to decide which solution is best for your application.</p>
806

807
    <h3 id="browser-zoom">Browser zooming</h3>
808
    <p>Page zooming inevitably presents rendering artifacts in some components, both in Bootstrap and the rest of the web. Depending on the issue, we may be able to fix it (search first and then open an issue if need be). However, we tend to ignore these as they often have no direct solution other than hacky workarounds.</p>
809
810
811
  </div>


812
813
814
815
816
817
  <!-- Third party support
  ================================================== -->
  <div class="bs-docs-section">
    <div class="page-header">
      <h1 id="third-parties">Third party support</h1>
    </div>
818
    <p class="lead">While we don't officially support any third party plugins or add-ons, we do offer some useful advice to help avoid potential issues in your projects.</p>
819

820
    <h3>Box-sizing</h3>
821
822
    <p>Some third party software, including Google Maps and Google Custom Search Engine, conflict with Bootstrap due to <code>* { box-sizing: border-box; }</code>, a rule which makes it so <code>padding</code> does not affect the final computed width of an element. Learn more about <a href="http://css-tricks.com/box-sizing/">box model and sizing at CSS Tricks</a>.</p>
    <p>Depending on the context, you may override as-needed (Option 1) or reset the box-sizing for entire regions (Option 2).</p>
823
{% highlight css %}
824
/* Box-sizing resets
825
 *
826
 * Reset individual elements or override regions to avoid conflicts due to
827
828
 * global box model settings of Bootstrap. Two options, individual overrides and
 * region resets, are available as plain CSS and uncompiled LESS formats.
829
830
 */

831
832
/* Option 1A: Override a single element's box model via CSS */
.element {
833
834
835
836
837
  -webkit-box-sizing: content-box;
     -moz-box-sizing: content-box;
          box-sizing: content-box;
}

838
/* Option 1B: Override a single element's box model by using a Bootstrap LESS mixin */
839
.element {
840
841
  .box-sizing(content-box);
}
842
843
844
845
846
847
848
849
850
851
852

/* Option 2A: Reset an entire region via CSS */
.reset-box-sizing,
.reset-box-sizing *,
.reset-box-sizing *:before,
.reset-box-sizing *:after {
  -webkit-box-sizing: content-box;
     -moz-box-sizing: content-box;
          box-sizing: content-box;
}

853
/* Option 2B: Reset an entire region with a custom LESS mixin */
854
855
856
857
858
859
860
861
862
863
864
.reset-box-sizing {
  &,
  *,
  *:before,
  *:after {
    .box-sizing(content-box);
  }
}
.element {
  .reset-box-sizing();
}
865
866
867
868
{% endhighlight %}
  </div>


869
870
871
872
873
874
  <!-- Accessibility
  ================================================== -->
  <div class="bs-docs-section">
    <div class="page-header">
      <h1 id="accessibility">Accessibility</h1>
    </div>
875
    <p class="lead">Bootstrap follows common web standards, and with minimal extra effort, can be used to create sites that are accessible to those using <abbr title="Assistive Technology" class="initialism">AT</abbr>.</p>
876

Mark Otto's avatar
Mark Otto committed
877
    <h3>Skip navigation</h3>
878
    <p>If your navigation contains many links and comes before the main content in the DOM, add a <code>Skip to main content</code> link immediately after your opening <code>&lt;body&gt;</code> tag. <a href="http://a11yproject.com/posts/skip-nav-links/">(read why)</a></p>
879
880
{% highlight html %}
<body>
881
  <a href="#content" class="sr-only">Skip to main content</a>
882
883
884
885
886
887
  <div class="container" id="content">
    The main page content.
  </div>
</body>
{% endhighlight %}

888
889
890
    <h3>Nested headings</h3>
    <p>When nesting headings (<code>&lt;h1&gt;</code> - <code>&lt;h6&gt;</code>), your primary document header should be an <code>&lt;h1&gt;</code>. Subsequent headings should make logical use of <code>&lt;h2&gt;</code> - <code>&lt;h6&gt;</code> such that screen readers can construct a table of contents for your pages.</p>
    <p>Learn more at <a href="http://squizlabs.github.io/HTML_CodeSniffer/Standards/Section508/">HTML CodeSniffer</a> and <a href="http://accessibility.psu.edu/headings">Penn State's AccessAbility</a>.</p>
891

Mark Otto's avatar
Mark Otto committed
892
    <h3>Additional resources</h3>
893
894
895
896
897
898
899
900
    <ul>
      <li><a href="https://github.com/squizlabs/HTML_CodeSniffer">"HTML Codesniffer" bookmarklet for identifying accessibility issues</a></li>
      <li><a href="http://a11yproject.com/">The A11Y Project</a></li>
      <li><a href="https://developer.mozilla.org/en-US/docs/Accessibility">MDN accessibility documentation</a></li>
    </ul>
  </div>


901
902
  <!-- License FAQs
  ================================================== -->
Mark Otto's avatar
Mark Otto committed
903
  <div class="bs-docs-section">
904
    <div class="page-header">
Mark Otto's avatar
Mark Otto committed
905
      <h1 id="license-faqs">License FAQs</h1>
906
    </div>
907
    <p class="lead">Bootstrap is released under the Apache 2 license and is copyright {{ site.time | date: "%Y" }} Twitter. Boiled down to smaller chunks, it can be described with the following conditions.</p>
908
909
910
911
912

    <div class="row">
      <div class="col-12 col-lg-6">
        <h4>It allows you to:</h4>
        <ul>
913
914
          <li>Freely download and use Bootstrap, in whole or in part, for personal, company internal or commercial purposes</li>
          <li>Use Bootstrap in packages or distributions that you create</li>
915
916
917
918
919
        </ul>
      </div>
      <div class="col-12 col-lg-6">
        <h4>It forbids you to:</h4>
        <ul>
920
          <li>Redistribute any piece of Bootstrap without proper attribution</li>
921
922
923
924
925
926
927
928
929
          <li>Use any marks owned by Twitter in any way that might state or imply that Twitter endorses your distribution</li>
          <li>Use any marks owned by Twitter in any way that might state or imply that you created the Twitter software in question</li>
        </ul>
      </div>
    </div>
    <div class="row">
      <div class="col-12 col-lg-6">
        <h4>It requires you to:</h4>
        <ul>
930
931
          <li>Include a copy of the license in any redistribution you may make that includes Bootstrap</li>
          <li>Provide clear attribution to Twitter for any distributions that include Bootstrap</li>
932
933
934
935
936
        </ul>
      </div>
      <div class="col-12 col-lg-6">
        <h4>It does not require you to:</h4>
        <ul>
937
          <li>Include the source of Bootstrap itself, or of any modifications you may have made to it, in any redistribution you may assemble that includes it</li>
938
          <li>Submit changes that you make to Bootstrap back to the Bootstrap project (though such feedback is encouraged)</li>
939
940
941
        </ul>
      </div>
    </div>
Mark Otto's avatar
Mark Otto committed
942
    <p>The full Bootstrap license is located <a href="{{ site.repo }}/blob/master/README.md">in the project repository</a> for more information.</p>
943
944
945
  </div><!-- /.bs-docs-section -->


Mark Otto's avatar
Mark Otto committed
946
  <div class="bs-docs-section">
Mark Otto's avatar
Mark Otto committed
947
    <div class="page-header">
Mark Otto's avatar
Mark Otto committed
948
      <h1 id="customizing">Customizing Bootstrap</h1>
Mark Otto's avatar
Mark Otto committed
949
    </div>
950
    <p class="lead">Bootstrap is best maintained when you treat it as a separate and independently-versioned dependency in your development environment. Doing this makes upgrading Bootstrap easier in the future.</p>
Mark Otto's avatar
Mark Otto committed
951

952
    <p>Once you've downloaded and included Bootstrap's styles and scripts, you can customize its components. Just create a new stylesheet (LESS, if you like, or just plain CSS) to house your customizations.</p>
Mark Otto's avatar
Mark Otto committed
953

954
    <div class="bs-callout bs-callout-info">
Mark Otto's avatar
Mark Otto committed
955
      <h4>Compiled or minified?</h4>
956
      <p>Unless you plan on reading the CSS, go with minified stylesheets. It's the same code, just compacted. Minified styles use less bandwidth, which is good, especially in production environments.</p>
Mark Otto's avatar
Mark Otto committed
957
958
    </div>

959
    <p>From there, include whatever Bootstrap components and HTML content you need to create templates for your site's pages.</p>
Mark Otto's avatar
Mark Otto committed
960
961

    <h3>Customizing components</h3>
962
963
964
    <p>You can customize components to varying degrees, but most fall into two camps: <em>light customizations</em> and <em>overhauls</em>. Plenty examples of both are available from third parties.</p>
    <p>We define <em>light customizations</em> as superficial changes, for example, color and font changes to existing Bootstrap components. A light customization example is the <a href="http://translate.twitter.com">Twitter Translation Center</a> (coded by <a href="https://twitter.com/mdo">@mdo</a>). Let's look at how to implement the custom button we wrote for this site, <code>.btn-ttc</code>.</p>
    <p>The stock Bootstrap buttons require just one class, <code>.btn</code>, to start.  Here we extend the <code>.btn</code> style with a new modifier class, <code>.btn-ttc</code>, that we will create. This gives us a distinct custom look with minimal effort.</p>
965
    <p>Our customized button will be coded like this:</p>
Mark Otto's avatar
Mark Otto committed
966
967
968
{% highlight html %}
<button type="button" class="btn btn-ttc">Save changes</button>
{% endhighlight %}
969
    <p>Note how <code>.btn-ttc</code> is added to the standard <code>.btn</code> class.</p>
Mark Otto's avatar
Mark Otto committed
970

971
    <p>To implement this, in the custom stylesheet, add the following CSS:</p>
Mark Otto's avatar
Mark Otto committed
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000

{% highlight css %}
/* Custom button
-------------------------------------------------- */

/* Override base .btn styles */
/* Apply text and background changes to three key states: default, hover, and active (click). */
.btn-ttc,
.btn-ttc:hover,
.btn-ttc:active {
  color: white;
  text-shadow: 0 -1px 0 rgba(0, 0, 0, 0.25);
  background-color: #007da7;
}

/* Apply the custom-colored gradients */
/* Note: you'll need to include all the appropriate gradients for various browsers and standards. */
.btn-ttc {
  background-repeat: repeat-x;
  background-image: linear-gradient(top, #009ED2 0%, #007DA7 100%);
  ...
}

/* Set the hover state */
/* An easy hover state is just to move the gradient up a small amount. Add other embellishments as you see fit. */
.btn-ttc:hover {
  background-position: 0 -15px;
}
{% endhighlight %}
For faster browsing, not all history is shown. View entire blame