getting-started.html 29.3 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
16
17
18
    </div>
    <p class="lead">There are a few easy ways to quickly get started with Bootstrap, each one appealing to a different skill level and use case. Read through to see what suits your particular needs.</p>

    <h3>Download compiled CSS and JS</h3>
Quy Ton's avatar
Quy Ton committed
19
    <p class="lead">The fastest way to get started is to get the compiled and minified versions of our CSS and JavaScript. No documentation or original source 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']);">Download 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 }}" onclick="_gaq.push(['_trackEvent', 'Getting started', 'Download', 'Download source']);">Download latest source code</a>
Mark Otto's avatar
Mark Otto committed
26
27
28
      </h4>
      <p>Get the original files for all CSS and JavaScript by downloading the latest version directly from GitHub.</p>
      <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
31
32
      </h4>
      <p>Clone the entire project or fork your own version of Bootstrap to make it your own by visiting us on GitHub.</p>
      <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>
Francis Brunelle's avatar
Francis Brunelle committed
35
      <p>Install and manage the original files for all CSS and JavaScript, along with a local copy of the docs, 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>
Mark Otto's avatar
Mark Otto committed
40
41
42
    <p>The folks over at <a href="https://www.netdna.com/">NetDNA</a> have graciously provided CDN support for Bootstrap's CSS and JavaScript. To use, swap your local instances for the <a href="http://www.bootstrapcdn.com/">Bootstrap CDN</a> links listed below.</p>
{% highlight html linenos %}
<!-- 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

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

49
    <div class="bs-callout bs-callout-warning" id="callout-less-compilation">
50
      <h4>LESS compilation</h4>
Julian Thilo's avatar
Julian Thilo committed
51
      <p>If you download the original files, you need to compile Bootstrap's LESS files into usable CSS. To do that, Bootstrap only officially supports <a href="http://twitter.github.io/recess/">Recess</a>, Twitter's CSS hinter built on top of <a href="http://lesscss.org">less.js</a>.</p>
52
    </div>
Mark Otto's avatar
Mark Otto committed
53
54
  </div>

55
56


Mark Otto's avatar
Mark Otto committed
57
58
  <!-- File structure
  ================================================== -->
Mark Otto's avatar
Mark Otto committed
59
  <div class="bs-docs-section">
Mark Otto's avatar
Mark Otto committed
60
    <div class="page-header">
Mark Otto's avatar
Mark Otto committed
61
      <h1 id="whats-included">What's included</h1>
Mark Otto's avatar
Mark Otto committed
62
63
64
65
66
    </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
67
68
69
70
71
72
73
bootstrap/
├── css/
│   ├── bootstrap.css
│   ├── bootstrap.min.css
├── js/
│   ├── bootstrap.js
│   ├── bootstrap.min.js
Mark Otto's avatar
Mark Otto committed
74
75
{% endhighlight %}

liuyl's avatar
liuyl committed
76
    <p>This is the most basic form of Bootstrap: compiled 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>).</p>
77
    <div class="bs-callout bs-callout-danger">
Mark Otto's avatar
Mark Otto committed
78
      <h4>jQuery required</h4>
Mark Otto's avatar
Mark Otto committed
79
      <p>Please note that <strong>all JavaScript plugins require jQuery</strong> to be included, as shown in the <a href="#template">starter template</a>.</p>
Mark Otto's avatar
Mark Otto committed
80
81
82
    </div>
  </div>

83

84

85
  <!-- Template
Mark Otto's avatar
Mark Otto committed
86
  ================================================== -->
Mark Otto's avatar
Mark Otto committed
87
  <div class="bs-docs-section">
Mark Otto's avatar
Mark Otto committed
88
    <div class="page-header">
Mark Otto's avatar
Mark Otto committed
89
      <h1 id="template">Basic template</h1>
Mark Otto's avatar
Mark Otto committed
90
    </div>
91
    <p class="lead">Make use of a super basic HTML template, or dive into a <a href="../getting-started#examples">few examples</a> we've started for you. We encourage folks to iterate on these examples and not simply use them as an end result.</p>
Mark Otto's avatar
Mark Otto committed
92
93
94
95
96
97
98
99
100
101
102
103
104
105

    <p>Copy and paste the HTML from below to get started with a bare bones Bootstrap document.</p>
{% 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">
  </head>
  <body>
    <h1>Hello, world!</h1>

Chris Rebert's avatar
Chris Rebert committed
106
    <!-- jQuery (necessary for Bootstrap's JavaScript plugins) -->
107
    <script src="//code.jquery.com/jquery.js"></script>
Mark Otto's avatar
Mark Otto committed
108
109
110
    <!-- Include all compiled plugins (below), or include individual files as needed -->
    <script src="js/bootstrap.min.js"></script>

Mark Otto's avatar
Mark Otto committed
111
    <!-- Enable responsive features in IE8 with Respond.js (https://github.com/scottjehl/Respond) -->
Mark Otto's avatar
Mark Otto committed
112
113
114
115
116
117
118
119
    <script src="js/respond.js"></script>
  </body>
</html>
{% endhighlight %}
  </div>



120
121
122
123
124
125
126
127
  <!-- Template
  ================================================== -->
  <div class="bs-docs-section">
    <div class="page-header">
      <h1 id="examples">Examples</h1>
    </div>
    <p class="lead">Build on the basic template above with Bootstrap's many components. Check out some of the more advanced tips for how to customize and build on top of them.</p>

128
    <div class="row bs-examples">
129
      <div class="col-xs-6 col-md-4">
130
131
        <a class="thumbnail" href="../examples/starter-template/">
          <img src="../examples/screenshots/starter-template.jpg" alt="">
132
        </a>
133
134
        <h4>Starter template</h4>
        <p>Nothing but the basics: compiled CSS and JavaScript along with a container.</p>
135
136
      </div>
      <div class="col-xs-6 col-md-4">
137
138
        <a class="thumbnail" href="../examples/grid/">
          <img src="../examples/screenshots/grid.jpg" alt="">
139
        </a>
140
141
        <h4>Grids</h4>
        <p>Multiple examples of grid layouts with all four tiers, nesting, and more.</p>
142
143
144
145
      </div>
      <div class="clearfix visible-xs"></div>

      <div class="col-xs-6 col-md-4">
146
147
        <a class="thumbnail" href="../examples/jumbotron/">
          <img src="../examples/screenshots/jumbotron.jpg" alt="">
148
        </a>
149
150
        <h4>Jumbotron</h4>
        <p>Build around the jumbotron with a navbar and some basic grid columns.</p>
151
152
      </div>
      <div class="col-xs-6 col-md-4">
153
154
        <a class="thumbnail" href="../examples/jumbotron-narrow/">
          <img src="../examples/screenshots/jumbotron-narrow.jpg" alt="">
155
        </a>
156
157
        <h4>Narrow jumbotron</h4>
        <p>Build a more custom page by narrowing the default container and jumbotron.</p>
158
159
160
161
      </div>
      <div class="clearfix visible-xs"></div>

      <div class="col-xs-6 col-md-4">
162
163
        <a class="thumbnail" href="../examples/navbar/">
          <img src="../examples/screenshots/navbar.jpg" alt="">
164
        </a>
165
166
        <h4>Navbar</h4>
        <p>Super basic template that includes the navbar along with some additional content.</p>
167
168
      </div>
      <div class="col-xs-6 col-md-4">
169
170
        <a class="thumbnail" href="../examples/navbar-static-top/">
          <img src="../examples/screenshots/navbar-static.jpg" alt="">
171
        </a>
172
173
        <h4>Static top navbar</h4>
        <p>Super basic template with a static top navbar along with some additional content.</p>
174
175
176
177
      </div>
      <div class="clearfix visible-xs"></div>

      <div class="col-xs-6 col-md-4">
178
179
        <a class="thumbnail" href="../examples/navbar-fixed-top/">
          <img src="../examples/screenshots/navbar-fixed.jpg" alt="">
180
        </a>
181
182
        <h4>Fixed navbar</h4>
        <p>Super basic template with a fixed top navbar along with some additional content.</p>
183
184
      </div>
      <div class="col-xs-6 col-md-4">
185
186
        <a class="thumbnail" href="../examples/signin/">
          <img src="../examples/screenshots/sign-in.jpg" alt="">
187
        </a>
188
189
        <h4>Sign-in page</h4>
        <p>Custom form layout and design for a simple sign in form.</p>
190
191
192
193
      </div>
      <div class="clearfix visible-xs"></div>

      <div class="col-xs-6 col-md-4">
194
195
        <a class="thumbnail" href="../examples/sticky-footer/">
          <img src="../examples/screenshots/sticky-footer.jpg" alt="">
196
        </a>
197
198
        <h4>Sticky footer</h4>
        <p>Attach a footer to the bottom of the viewport when the content is shorter than it.</p>
199
200
      </div>
      <div class="col-xs-6 col-md-4">
201
202
        <a class="thumbnail" href="../examples/sticky-footer-navbar/">
          <img src="../examples/screenshots/sticky-footer-navbar.jpg" alt="">
203
        </a>
204
        <h4>Sticky footer with navbar</h4>
Mark Otto's avatar
Mark Otto committed
205
        <p>Attach a footer to the bottom of the viewport with a fixed navbar at the top.</p>
206
207
208
      </div>
      <div class="clearfix visible-xs"></div>

Mark Otto's avatar
Mark Otto committed
209
210
211
212
213
214
215
      <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>
        <p>Expand on the default navbar and more to create justified navigation links.</p>
      </div>
216
      <div class="col-xs-6 col-md-4">
217
218
        <a class="thumbnail" href="../examples/offcanvas/">
          <img src="../examples/screenshots/offcanvas.jpg" alt="">
219
        </a>
220
221
        <h4>Offcanvas</h4>
        <p>Build a toggleable off-canvas navigation menu for use with Bootstrap.</p>
222
      </div>
Mark Otto's avatar
Mark Otto committed
223
224
      <div class="clearfix visible-xs"></div>

225
      <div class="col-xs-6 col-md-4">
226
227
        <a class="thumbnail" href="../examples/carousel/">
          <img src="../examples/screenshots/carousel.jpg" alt="">
228
        </a>
229
230
        <h4>Carousel</h4>
        <p>Customize the navbar and carousel, then add some new components.</p>
231
      </div>
232
233
234
235
236
237
238
      <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>
239
      <div class="clearfix visible-xs"></div>
240

241
242
243
244
245
246
247
      <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>
248
249
250
251
252
253
    </div>

  </div>



254
255
256
257
258
259
  <!-- Template
  ================================================== -->
  <div class="bs-docs-section">
    <div class="page-header">
      <h1 id="disable-responsive">Disabling responsiveness</h1>
    </div>
Mark Otto's avatar
Mark Otto committed
260
    <p class="lead">Don't want your site or application to be scaled on different devices? With a little bit of work, you can disable the responsive features of Bootstrap so that mobile users see your full desktop-version site. Read below or check out <a href="../examples/non-responsive/">the non-responsive example</a>.</p>
261

262
    <h3>Steps to disable responsive views</h3>
263
264
    <p>To disable responsive features, follow these steps. See it in action in the modified template below.</p>
    <ol>
265
      <li>Remove (or just don't add) the viewport <code>&lt;meta&gt;</code> mentioned in <a href="../css/#overview-mobile">the CSS docs</a></li>
Mark Otto's avatar
Mark Otto committed
266
      <li>Remove the <code>max-width</code> on the <code>.container</code> for all grid tiers with <code>max-width: none !important;</code> and set a regular width like <code>width: 970px;</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>
267
      <li>For grid layouts, make use of <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 up to all resolutions, so you're set there.</li>
268
269
270
    </ol>
    <p>You'll still need respond.js for IE8 (since our media queries are still there and need to be picked up). This just disables the "mobile site" of Bootstrap.</p>

271
272
    <h3>Bootstrap template with disabled responsive</h3>
    <p>We've taken the above steps and applied them to a basic template here. Note the steps above are called out in comments here, e.g. <code>&lt;-- 1. --&gt;</code>.</p>
273
274
275
276
277
278
279
280
281
282
283
284
285
{% highlight html %}
<!DOCTYPE html>
<html>
  <head>
    <title>Disabling responsiveness in Bootstrap</title>

    <!-- 1. Note there is no meta tag here -->

    <!-- Load default Bootstrap -->
    <link href="css/bootstrap.min.css" rel="stylesheet" media="screen">

    <!-- 2. Add our custom CSS to set the container's fixed width -->
    <style>
286
287
288
289
      .container {
        max-width: none !important;
        width: 970px;
      }
290
291
292
293
294
295
    </style>
  </head>
  <body>

    <h1>Hello, world!</h1>

296
297
298
299
300
301
302
    <!-- 3. When using grid columns, use the `.col-xs-*` classes -->
    <div class="row">
      <div class="col-xs-4">One third</div>
      <div class="col-xs-4">One third</div>
      <div class="col-xs-4">One third</div>
    </div>

303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
    <!-- jQuery (necessary for Bootstrap's JavaScript plugins) -->
    <script src="//code.jquery.com/jquery.js"></script>

    <!-- Include all compiled plugins (below), or include individual files as needed -->
    <script src="js/bootstrap.min.js"></script>

    <!-- Enable responsive features in IE8 with Respond.js (https://github.com/scottjehl/Respond) -->
    <script src="js/respond.js"></script>
  </body>
</html>
{% endhighlight %}
  </div>



318
  <!-- Browser support
319
  ================================================== -->
Mark Otto's avatar
Mark Otto committed
320
  <div class="bs-docs-section">
321
    <div class="page-header">
322
      <h1 id="browsers">Browser support</h1>
323
324
325
    </div>
    <p class="lead">Bootstrap is built to work best in the latest desktop and mobile browsers, meaning older and less advanced browsers might receive a less stylized, though fully functional, version of certain components.</p>

326
    <h3>Supported browsers</h3>
327
328
329
330
331
332
333
334
    <p>Specifically, we support the latest versions of the following:</p>
    <ul>
      <li>Chrome (Mac, Windows, iOS, and Android)</li>
      <li>Safari (Mac and iOS only, as Windows has more or less been discontinued)</li>
      <li>Firefox (Mac, Windows)</li>
      <li>Internet Explorer</li>
      <li>Opera (Mac, Windows)</li>
    </ul>
335
336
337
    <p>Unofficially, Bootstrap should look and behave well enough in Chromium for Linux and Internet Explorer 7, though they are not officially supported.</p>

    <h3>Internet Explorer 8 and 9</h3>
338
    <p>Internet Explorer 8 and 9 are also supported, however, please be aware that many CSS3 properties—e.g., rounded corners and shadows—are not supported by IE8. The <code>placeholder</code> attribute is also not supported in either of these versions.</p>
339
    <p>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>
340

341
    <h3>IE Compatibility modes</h3>
342
    <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>meta</code> tag in your pages:</p>
Mark Otto's avatar
Mark Otto committed
343
344
345
346
{% 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>
347
348
349
350
351
352
353
354
355
356
357
358
359

    <h3>Windows Phone 8 and Internet Explorer 10</h3>
    <p>Internet Explorer 10 doesn't differentiate device width from viewport width, and thus doesn't properly apply the media queries in Bootstrap's CSS. To address this, you can optionally include the following CSS and JavaScript to work around this problem until Microsoft issues a fix.</p>
{% 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
360
  var msViewportStyle = document.createElement("style")
361
362
363
364
  msViewportStyle.appendChild(
    document.createTextNode(
      "@-ms-viewport{width:auto!important}"
    )
Chris Rebert's avatar
Chris Rebert committed
365
366
  )
  document.getElementsByTagName("head")[0].appendChild(msViewportStyle)
367
368
}
{% endhighlight %}
Mark Otto's avatar
Mark Otto committed
369
    <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>
370
371

    <h3>Safari percent rounding</h3>
Chris Rebert's avatar
Chris Rebert committed
372
    <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. There's not much we can do here (<a href="https://github.com/twbs/bootstrap/issues/9282">see #9282</a>) but you do have some options:</p>
373
374
    <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
375
      <li>Tweak your percentages manually to get the perfect rounding for Safari (more difficult than the first option)</li>
376
377
    </ul>
    <p>We'll keep an eye on this though and update our code if we have an easy solution.</p>
378
379

    <h3>Modals and mobile devices</h3>
380
    <h4>Overflow and scrolling</h4>
381
    <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>
382
    <h4>Virtual keyboards</h4>
383
    <p>Also, note that if you're using inputs in your modal – iOS has a rendering bug which doesn't update the position of fixed elements when the virtual keyboard is triggered. There are a few work arounds for this, including 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>
384
385
386

    <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>
387
388
389
390
  </div>



391
392
393
394
395
396
  <!-- Third party support
  ================================================== -->
  <div class="bs-docs-section">
    <div class="page-header">
      <h1 id="third-parties">Third party support</h1>
    </div>
397
    <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>
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420

    <h3>Google Maps</h3>
    <p>If you're using Google Maps on a Bootstrapped project, you might run into some display problems due to our use of <code>* { box-sizing: border-box; }</code>. Previously, you may have also ran into issues with the use of <code>max-width</code> on images. The following snippet should avoid all those problems.</p>
{% highlight css %}
/* Fix Google Maps canvas
 *
 * Wrap your Google Maps embed in a `.google-map-canvas` to reset Bootstrap's
 * global `box-sizing` changes. You may optionally need to reset the `max-width`
 * on images in case you've applied that anywhere else. (That shouldn't be as
 * necessary with Bootstrap 3 though as that behavior is relegated to the
 * `.img-responsive` class.)
 */

.google-map-canvas,
.google-map-canvas * { .box-sizing(content-box); }

/* Optional responsive image override */
img { max-width: none; }
{% endhighlight %}
  </div>



421
422
423
424
425
426
  <!-- Accessibility
  ================================================== -->
  <div class="bs-docs-section">
    <div class="page-header">
      <h1 id="accessibility">Accessibility</h1>
    </div>
Mark Otto's avatar
Mark Otto committed
427
    <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>
428

Mark Otto's avatar
Mark Otto committed
429
430
    <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>
431
432
433
434
435
436
437
438
439
{% 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 %}

Mark Otto's avatar
Mark Otto committed
440
441
    <h3>Nested headers</h3>
    <p>Another "gotcha" has to do with how you nest your <code>&lt;header&gt;</code> elements. <a href="http://squizlabs.github.io/HTML_CodeSniffer/Standards/Section508/">Section 508</a> states that your largest header must be an <code>h1</code>, and the next header must be an <code>&lt;h2&gt;</code>, etc. This is hard to achieve in practice, but if the largest header on your site is smaller than Bootstrap's default 38px, you should consider modifying your stylesheets before using a smaller header element.</p>
442

Mark Otto's avatar
Mark Otto committed
443
    <h3>Additional resources</h3>
444
445
446
447
448
449
450
451
452
    <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>



453
454
  <!-- License FAQs
  ================================================== -->
Mark Otto's avatar
Mark Otto committed
455
  <div class="bs-docs-section">
456
    <div class="page-header">
Mark Otto's avatar
Mark Otto committed
457
      <h1 id="license-faqs">License FAQs</h1>
458
    </div>
459
    <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>
460
461
462
463
464

    <div class="row">
      <div class="col-12 col-lg-6">
        <h4>It allows you to:</h4>
        <ul>
465
466
          <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>
467
468
469
470
471
        </ul>
      </div>
      <div class="col-12 col-lg-6">
        <h4>It forbids you to:</h4>
        <ul>
472
          <li>Redistribute any piece of Bootstrap without proper attribution</li>
473
474
475
476
477
478
479
480
481
          <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>
482
483
          <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>
484
485
486
487
488
        </ul>
      </div>
      <div class="col-12 col-lg-6">
        <h4>It does not require you to:</h4>
        <ul>
489
          <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>
490
          <li>Submit changes that you make to Bootstrap back to the Bootstrap project (though such feedback is encouraged)</li>
491
492
493
        </ul>
      </div>
    </div>
Mark Otto's avatar
Mark Otto committed
494
    <p>The full Bootstrap license is located <a href="{{ site.repo }}/blob/master/README.md">in the project repository</a> for more information.</p>
495
496
497
498
  </div><!-- /.bs-docs-section -->



Mark Otto's avatar
Mark Otto committed
499

Mark Otto's avatar
Mark Otto committed
500
  <div class="bs-docs-section">
Mark Otto's avatar
Mark Otto committed
501
    <div class="page-header">
Mark Otto's avatar
Mark Otto committed
502
      <h1 id="customizing">Customizing Bootstrap</h1>
Mark Otto's avatar
Mark Otto committed
503
504
505
506
507
    </div>
    <p class="lead">Customizing Bootstrap is best accomplished when you treat it as another dependency in your development stack. Doing so ensures future upgrades are as easy as possible while also familiarizing yourself to the intricacies of the framework.</p>

    <p>Once you've downloaded and included Bootstrap's CSS into your templates, you can move on to customizing the included components. To do so, create a new stylesheet (LESS, if you like, or just plain CSS) to house your customizations.</p>

508
    <div class="bs-callout bs-callout-info">
Mark Otto's avatar
Mark Otto committed
509
510
511
512
513
514
515
516
517
518
519
520
521
522
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
      <h4>Compiled or minified?</h4>
      <p>Unless you plan on reading a good chunk of the compiled CSS, go with the minified. It's the same code, just compacted. Less bandwidth is good, especially in production environments.</p>
    </div>

    <p>From there, include whatever Bootstrap components and HTML content you need to get your template setup. It's best to have a rough idea in mind of modifications to make and content to include, so be sure to spend a brief amount of time on that before moving on.</p>

    <h3>Customizing components</h3>
    <p>There are varying degrees to customizing components, but most fall into two camps: light customizations and complete visual overhauls. Luckily, there are plenty of examples of both.</p>
    <p>We define light customizations as mostly surface layer changes, things like a color and font changes to existing Bootstrap components. A great example of this is the the <a href="http://translate.twitter.com">Twitter Translation Center</a> (coded by @mdo). Let's look at how to implement the custom button we wrote for this site, <code>.btn-ttc</code>.</p>
    <p>Instead of using the provided Bootstrap buttons, which only require just one class to start, <code>.btn</code>, we'll add our own modifier class, <code>.btn-ttc</code>. This will give us a slightly custom look with minimal effort.</p>
{% highlight html %}
<button type="button" class="btn btn-ttc">Save changes</button>
{% endhighlight %}

  <p>In the custom stylesheet, add the following CSS:</p>

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

    <p>Customizing Bootstrap components takes time, but should be straightforward. <strong>Look to the source code often and duplicate the selectors you need for your modifications.</strong> Placing them after the Bootstrap source makes for easy overriding without complication. <strong>To recap, here's the basic workflow:</strong></p>
    <ul>
      <li>For each element you want to customize, find its code in the compiled Bootstrap CSS. Copy and paste the selector for a component as-is. For instance, to customize the navbar background, just snag <code>.navbar</code>.</li>
      <li>Add all your custom CSS in a separate stylesheet using the selectors you just copied from the Bootstrap source. No need for prefacing with additional classes or using <code>!important</code> here.</li>
      <li>Rinse and repeat until you're happy with your customizations.</li>
    </ul>
    <p>Going beyond light customizations and into visual overhauls is just as straightforward as the above custom button. 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 well worth it in the end.</p>

562
    <div class="bs-callout bs-callout-info">
Mark Otto's avatar
Mark Otto committed
563
      <h4>Alternate customization methods</h4>
564
      <p>While not recommended for folks new to Bootstrap, you may use one of two alternate methods for customization. The first is modifying the source .less files (making upgrades super difficult), and the second is mapping source LESS code to <a href="http://ruby.bvision.com/blog/please-stop-embedding-bootstrap-classes-in-your-html">your own classes via mixins</a>. For the time being, neither of those options are documented here.</p>
Mark Otto's avatar
Mark Otto committed
565
566
567
    </div>

    <h3>Removing potential bloat</h3>
568
    <p>Not all sites and applications need to make use of everything Bootstrap has to offer, especially in production environments where bandwidth literally becomes a financial issue. We encourage folks to remove whatever is unused with our <a href="../customize/">Customizer</a>.</p>
Mark Otto's avatar
Mark Otto committed
569
570
571
    <p>Using the Customizer, simply uncheck any component, feature, or asset you don't need. Hit download and swap out the default Bootstrap files with these newly customized ones. You'll get vanilla Bootstrap, but without the features *you* deem unnecessary. All custom builds include compiled and minified versions, so use whichever works for you.</p>

  </div>