getting-started.html 46.2 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
58
59
  </div>

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

{% highlight bash %}
Mark Otto's avatar
Mark Otto committed
68
69
70
71
bootstrap/
├── css/
│   ├── bootstrap.css
│   ├── bootstrap.min.css
Mark Otto's avatar
Mark Otto committed
72
│   ├── bootstrap-theme.css
73
│   └── bootstrap-theme.min.css
Mark Otto's avatar
Mark Otto committed
74
75
├── js/
│   ├── bootstrap.js
76
│   └── bootstrap.min.js
Mark Otto's avatar
Mark Otto committed
77
78
79
80
81
└── fonts/
    ├── glyphicons-halflings-regular.eot
    ├── glyphicons-halflings-regular.svg
    ├── glyphicons-halflings-regular.ttf
    └── glyphicons-halflings-regular.woff
Mark Otto's avatar
Mark Otto committed
82
83
{% endhighlight %}

84
    <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>
85
    <div class="bs-callout bs-callout-danger">
Mark Otto's avatar
Mark Otto committed
86
      <h4>jQuery required</h4>
87
      <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
88
89
90
    </div>
  </div>

91

92
  <!-- Template
Mark Otto's avatar
Mark Otto committed
93
  ================================================== -->
Mark Otto's avatar
Mark Otto committed
94
  <div class="bs-docs-section">
Mark Otto's avatar
Mark Otto committed
95
    <div class="page-header">
Mark Otto's avatar
Mark Otto committed
96
      <h1 id="template">Basic template</h1>
Mark Otto's avatar
Mark Otto committed
97
    </div>
98
    <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
99

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

    <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
    <!--[if lt IE 9]>
      <script src="../../assets/js/html5shiv.js"></script>
      <script src="../../assets/js/respond.min.js"></script>
    <![endif]-->
Mark Otto's avatar
Mark Otto committed
115
116
117
118
  </head>
  <body>
    <h1>Hello, world!</h1>

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


129
130
131
132
133
134
  <!-- Template
  ================================================== -->
  <div class="bs-docs-section">
    <div class="page-header">
      <h1 id="examples">Examples</h1>
    </div>
135
    <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>
136

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

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

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

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

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

Mark Otto's avatar
Mark Otto committed
218
219
220
221
222
      <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
223
        <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
224
      </div>
225
      <div class="col-xs-6 col-md-4">
226
227
        <a class="thumbnail" href="../examples/offcanvas/">
          <img src="../examples/screenshots/offcanvas.jpg" alt="">
228
        </a>
229
230
        <h4>Offcanvas</h4>
        <p>Build a toggleable off-canvas navigation menu for use with Bootstrap.</p>
231
      </div>
Mark Otto's avatar
Mark Otto committed
232
233
      <div class="clearfix visible-xs"></div>

234
      <div class="col-xs-6 col-md-4">
235
236
        <a class="thumbnail" href="../examples/carousel/">
          <img src="../examples/screenshots/carousel.jpg" alt="">
237
        </a>
238
239
        <h4>Carousel</h4>
        <p>Customize the navbar and carousel, then add some new components.</p>
240
      </div>
241
242
243
244
245
246
247
      <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>
248
      <div class="clearfix visible-xs"></div>
249

250
251
252
253
254
255
256
      <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>
257
258
259
260
261
    </div>

  </div>


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

271
    <h3>Steps to disable page responsiveness</h3>
272
    <ol>
273
      <li>Omit the viewport <code>&lt;meta&gt;</code> mentioned in <a href="../css/#overview-mobile">the CSS docs</a></li>
274
      <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>
275
      <li>If using navbars, remove all navbar collapsing and expanding behavior.</li>
276
      <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>
277
    </ol>
278
    <p>You'll still need Respond.js for IE8 (since our media queries are still there and need to be processed).
279
      This disables the "mobile site" aspects of Bootstrap.</p>
280

281
282
    <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>
283
284
285
    <p>
      <a href="../examples/non-responsive/" class="btn btn-primary">View non-responsive example</a>
    </p>
286
287
288
  </div>


iatek's avatar
iatek committed
289
290
291
292
  <!-- Migration
  ================================================== -->
  <div class="bs-docs-section">
    <div class="page-header">
293
      <h1 id="migration">Migrating from 2.x to 3.0</h1>
iatek's avatar
iatek committed
294
    </div>
295
    <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
296
297

    <h2 id="migration-classes">Major class changes</h2>
298
    <p>This table shows the style changes between v2.x and v3.0.</p>
299
300
301
302
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
    <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
328
329
330
331
332
333
334
335
336
337
338
339
          <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>
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
          <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
364
365
366
367
          <tr>
            <td><code>.alert-error</code></td>
            <td><code>.alert-danger</code></td>
          </tr>
368
369
          <tr>
            <td><code>.visible-phone</code></td>
370
            <td><code>.visible-xs</code></td>
371
372
373
          </tr>
          <tr>
            <td><code>.visible-tablet</code></td>
374
            <td><code>.visible-sm</code></td>
375
376
377
          </tr>
          <tr>
            <td><code>.visible-desktop</code></td>
378
            <td><code>.visible-md</code></td>
379
380
381
          </tr>
          <tr>
            <td><code>.hidden-phone</code></td>
382
            <td><code>.hidden-xs</code></td>
383
384
385
          </tr>
          <tr>
            <td><code>.hidden-tablet</code></td>
386
            <td><code>.hidden-sm</code></td>
387
388
389
          </tr>
          <tr>
            <td><code>.hidden-desktop</code></td>
390
            <td><code>.hidden-md</code></td>
391
392
393
394
395
396
397
398
399
          </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>
400
401
402
403
          <tr>
            <td><code>.control-group</code></td>
            <td><code>.form-group</code></td>
          </tr>
404
          <tr>
Mark Otto's avatar
Mark Otto committed
405
406
            <td><code>.checkbox.inline</code> <code>.radio.inline</code></td>
            <td><code>.checkbox-inline</code> <code>.radio-inline</code></td>
407
408
          </tr>
          <tr>
Mark Otto's avatar
Mark Otto committed
409
            <td><code>.input-prepend</code> <code>.input-append</code></td>
410
411
412
413
414
415
416
417
418
419
            <td><code>.input-group</code></td>
          </tr>
          <tr>
            <td><code>.add-on</code></td>
            <td><code>.input-group-addon</code></td>
          </tr>
          <tr>
            <td><code>.thumbnail</code></td>
            <td><code>.img-thumbnail</code></td>
          </tr>
Mark Otto's avatar
Mark Otto committed
420
421
422
423
          <tr>
            <td><code>ul.unstyled</code></td>
            <td><code>.list-unstyled</code></td>
          </tr>
424
425
426
427
          <tr>
            <td><code>ul.inline</code></td>
            <td><code>.list-inline</code></td>
          </tr>
428
429
430
431
          <tr>
            <td><code>.muted</code></td>
            <td><code>.text-muted</code></td>
          </tr>
Chris Rebert's avatar
Chris Rebert committed
432
433
434
435
          <tr>
            <td><code>.text-error</code></td>
            <td><code>.text-danger</code></td>
          </tr>
436
437
438
439
          <tr>
            <td><code>.table .error</code></td>
            <td><code>.table .danger</code></td>
          </tr>
440
          <tr>
Chris Rebert's avatar
Chris Rebert committed
441
442
443
444
445
446
            <td><code>.bar</code></td>
            <td><code>.progress-bar</code></td>
          </tr>
          <tr>
            <td><code>.bar-*</code></td>
            <td><code>.progress-bar-*</code></td>
447
          </tr>
448
449
450
451
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>
          <tr>
            <td><code>.alert-error</code></td>
            <td><code>.alert-danger</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>
Mark Otto's avatar
Mark Otto committed
667
668
669
670
671
      <li>Text-based form controls are now 100% wide. Wrap inputs inside <code>&lt;div class="col-*"&gt;&lt;/div&gt;</code> to control input widths.</li>
      <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>
672
      <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
673
      <li>Typeahead has been dropped, in favor of using <a href="http://twitter.github.io/typeahead.js/">Twitter Typeahead</a>.</li>
674
      <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>
675
      <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
676
      <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
677
    </ul>
678
    <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
679
  </div>
680
681


682
  <!-- Browser support
683
  ================================================== -->
Mark Otto's avatar
Mark Otto committed
684
  <div class="bs-docs-section">
685
    <div class="page-header">
686
      <h1 id="browsers">Browser support</h1>
687
    </div>
688
    <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>
689

690
    <h3>Supported browsers</h3>
691
692
693
    <p>Specifically, we support the latest versions of the following:</p>
    <ul>
      <li>Chrome (Mac, Windows, iOS, and Android)</li>
694
      <li>Safari (Mac and iOS only, as the Windows version is being abandoned)</li>
695
696
697
698
      <li>Firefox (Mac, Windows)</li>
      <li>Internet Explorer</li>
      <li>Opera (Mac, Windows)</li>
    </ul>
Zlatan Vasović's avatar
Zlatan Vasović committed
699
    <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>
700
701

    <h3>Internet Explorer 8 and 9</h3>
702
703
704
705
706
    <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>
    <div class="table-responsive">
      <table class="table table-bordered table-striped">
        <thead>
          <tr>
707
708
709
            <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>
710
711
712
713
          </tr>
        </thead>
        <tbody>
          <tr>
714
            <th scope="row"><code>border-radius</code></th>
715
716
            <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>
717
718
          </tr>
          <tr>
719
            <th scope="row"><code>box-shadow</code></th>
720
721
            <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>
722
723
          </tr>
          <tr>
724
            <th scope="row"><code>transform</code></th>
725
726
            <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>
727
728
          </tr>
          <tr>
729
            <th scope="row"><code>transition</code></th>
730
            <td colspan="2" class="text-danger"><span class="glyphicon glyphicon-remove"></span> Not supported</td>
731
732
733
734
          </tr>
        </tbody>
        <tbody>
          <tr>
735
            <th scope="row"><code>placeholder</code></th>
736
            <td colspan="2" class="text-danger"><span class="glyphicon glyphicon-remove"></span> Not supported</td>
737
738
739
740
741
          </tr>
        </tbody>
      </table>
    </div>

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

744
    <h3>Internet Explorer 8 and box-sizing</h3>
745
    <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>
746

747
    <h3>IE Compatibility modes</h3>
Chris Rebert's avatar
Chris Rebert committed
748
    <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
749
750
751
752
{% highlight html %}
<meta http-equiv="X-UA-Compatible" content="IE=edge">
{% endhighlight %}
    <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>
753

754
755
756
757
758
759
    <h3>Internet Explorer 10 in Windows 8 and Windows Phone 8</h3>
    <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>
760
761
762
763
764
765
766
767
768
769
{% 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
770
  var msViewportStyle = document.createElement("style")
771
772
773
774
  msViewportStyle.appendChild(
    document.createTextNode(
      "@-ms-viewport{width:auto!important}"
    )
Chris Rebert's avatar
Chris Rebert committed
775
776
  )
  document.getElementsByTagName("head")[0].appendChild(msViewportStyle)
777
778
}
{% endhighlight %}
Mark Otto's avatar
Mark Otto committed
779
    <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>
780
    <p>As a heads up, we include this in the Bootstrap docs as an example.</p>
781
782

    <h3>Safari percent rounding</h3>
jody tate's avatar
jody tate committed
783
    <p>In the latest Safari for Mac, its rendering engine has a little trouble with the long decimal places of our <code>.col-*-1</code> grid classes, meaning if you have 12 individual columns you'll notice 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>
784
785
    <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
786
      <li>Tweak your percentages manually to get the perfect rounding for Safari (more difficult than the first option)</li>
787
788
    </ul>
    <p>We'll keep an eye on this though and update our code if we have an easy solution.</p>
789
790

    <h3>Modals and mobile devices</h3>
791
    <h4>Overflow and scrolling</h4>
792
    <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>
793
    <h4>Virtual keyboards</h4>
jody tate's avatar
jody tate committed
794
    <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 work arounds 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>
795
796
797

    <h3>Browser zooming</h3>
    <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>
798
799
800
  </div>


801
802
803
804
805
806
  <!-- Third party support
  ================================================== -->
  <div class="bs-docs-section">
    <div class="page-header">
      <h1 id="third-parties">Third party support</h1>
    </div>
807
    <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>
808

809
    <h3>Box-sizing</h3>
810
811
    <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>
812
{% highlight css %}
813
/* Box-sizing resets
814
 *
815
 * Reset individual elements or override regions to avoid conflicts due to
816
817
 * global box model settings of Bootstrap. Two options, individual overrides and
 * region resets, are available as plain CSS and uncompiled LESS formats.
818
819
 */

820
821
/* Option 1A: Override a single element's box model via CSS */
.element {
822
823
824
825
826
  -webkit-box-sizing: content-box;
     -moz-box-sizing: content-box;
          box-sizing: content-box;
}

827
/* Option 1B: Override a single element's box model by using a Bootstrap LESS mixin */
828
.element {
829
830
  .box-sizing(content-box);
}
831
832
833
834
835
836
837
838
839
840
841

/* 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;
}

842
/* Option 2B: Reset an entire region with a custom LESS mixin */
843
844
845
846
847
848
849
850
851
852
853
.reset-box-sizing {
  &,
  *,
  *:before,
  *:after {
    .box-sizing(content-box);
  }
}
.element {
  .reset-box-sizing();
}
854
855
856
857
{% endhighlight %}
  </div>


858
859
860
861
862
863
  <!-- Accessibility
  ================================================== -->
  <div class="bs-docs-section">
    <div class="page-header">
      <h1 id="accessibility">Accessibility</h1>
    </div>
Mark Otto's avatar
Mark Otto committed
864
    <p class="lead">Bootstrap follows common web standards, and with minimal extra effort, can be used to create sites that are accessibile to those using <abbr title="Assistive Technology" class="initialism">AT</abbr>.</p>
865

Mark Otto's avatar
Mark Otto committed
866
867
    <h3>Skip navigation</h3>
    <p>If your navigation contains many links and comes before the main content in the DOM, add a <code>Skip to 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>
868
869
870
871
872
873
874
875
876
{% highlight html %}
<body>
  <a href="#content" class="sr-only">Skip to content</a>
  <div class="container" id="content">
    The main page content.
  </div>
</body>
{% endhighlight %}

877
878
879
    <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>
880

Mark Otto's avatar
Mark Otto committed
881
    <h3>Additional resources</h3>
882
883
884
885
886
887
888
889
    <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>


890
891
  <!-- License FAQs
  ================================================== -->
Mark Otto's avatar
Mark Otto committed
892
  <div class="bs-docs-section">
893
    <div class="page-header">
Mark Otto's avatar
Mark Otto committed
894
      <h1 id="license-faqs">License FAQs</h1>
895
    </div>
896
    <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>
897
898
899
900
901

    <div class="row">
      <div class="col-12 col-lg-6">
        <h4>It allows you to:</h4>
        <ul>
902
903
          <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>
904
905
906
907
908
        </ul>
      </div>
      <div class="col-12 col-lg-6">
        <h4>It forbids you to:</h4>
        <ul>
909
          <li>Redistribute any piece of Bootstrap without proper attribution</li>
910
911
912
913
914
915
916
917
918
          <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>
919
920
          <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>
921
922
923
924
925
        </ul>
      </div>
      <div class="col-12 col-lg-6">
        <h4>It does not require you to:</h4>
        <ul>
926
          <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>
927
          <li>Submit changes that you make to Bootstrap back to the Bootstrap project (though such feedback is encouraged)</li>
928
929
930
        </ul>
      </div>
    </div>
Mark Otto's avatar
Mark Otto committed
931
    <p>The full Bootstrap license is located <a href="{{ site.repo }}/blob/master/README.md">in the project repository</a> for more information.</p>
932
933
934
  </div><!-- /.bs-docs-section -->


Mark Otto's avatar
Mark Otto committed
935
  <div class="bs-docs-section">
Mark Otto's avatar
Mark Otto committed
936
    <div class="page-header">
Mark Otto's avatar
Mark Otto committed
937
      <h1 id="customizing">Customizing Bootstrap</h1>
Mark Otto's avatar
Mark Otto committed
938
    </div>
939
    <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
940

941
    <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
942

943
    <div class="bs-callout bs-callout-info">
Mark Otto's avatar
Mark Otto committed
944
      <h4>Compiled or minified?</h4>
945
      <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
946
947
    </div>

948
    <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
949
950

    <h3>Customizing components</h3>
951
952
953
    <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>
954
    <p>Our customized button will be coded like this:</p>
Mark Otto's avatar
Mark Otto committed
955
956
957
{% highlight html %}
<button type="button" class="btn btn-ttc">Save changes</button>
{% endhighlight %}
958
    <p>Note how <code>.btn-ttc</code> is added to the standard <code>.btn</code> class.</p>
Mark Otto's avatar
Mark Otto committed
959

960
    <p>To implement this, in the custom stylesheet, add the following CSS:</p>
Mark Otto's avatar
Mark Otto committed
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990

{% 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 %}

991
992
    <p>In short: Look to the style source and duplicate the selectors you need for your modifications.</p>
    <p><strong>In summary, here's the basic workflow:</strong></p>
Mark Otto's avatar
Mark Otto committed
993
    <ul>
994
995
996
      <li>For each element you want to customize, find its code in the compiled Bootstrap CSS.</li>
      <li>Copy the component's selector and styles and paste them in your custom stylesheet. For instance, to customize the navbar background, just copy the <code>.navbar</code> style specificaton.</li>
      <li>In your custom stylesheet, edit the CSS you just copied from the Bootstrap source. No need for prepending additional classes, or appending <code>!important</code> here.  Keep it simple.</li>
Mark Otto's avatar
Mark Otto committed
997
998
      <li>Rinse and repeat until you're happy with your customizations.</li>
    </ul>
999
    <p>Once you are comfortable performing light customizations, visual overhauls are just as straightforward. For a site like <a href="http://yourkarma.com">Karma</a>, which uses Bootstrap as a CSS reset with heavy modifications, more extensive work is involved.  But the same principle applies: include Bootstrap's default stylesheet first, then apply your custom stylesheet.</p>
Mark Otto's avatar
Mark Otto committed
1000

For faster browsing, not all history is shown. View entire blame