docs.html 254 KB
Newer Older
1
2
---
layout: default
3
title: Bootstrap Documentation
4
5
6
---


7
<div class="bs-docs-container">
8

9
10
11
12
13
  <!-- Welcome
  ================================================== -->
  <div id="welcome" class="bs-docs-section-header">
    <h1>Welcome</h1>
    <p class="lead">Welcome to the Bootstrap documentation, the living, interactive style and code guide for all things Bootstrap. If you're new here, continue reading to learn how to get started. Otherwise, carry on you beautiful person you.</p>
14
15
  </div>

16
  <!-- Getting started
17
  ================================================== -->
18
  <div class="bs-docs-section" id="getting-started">
19
    <div class="page-header">
20
      <h1>Getting started</h1>
21
    </div>
Mark Otto's avatar
Mark Otto committed
22
    <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>
23
24
    <div class="row">
      <div class="col-span-6">
25
        <h3>Compiled CSS and JS</h3>
26
        <p><strong>The fastest way to get started:</strong> get the compiled and minified versions of our CSS, JavaScript, and fonts. No documentation or original source files are included.</p>
27
28
29
        <p><a class="btn btn-large btn-primary" href="assets/bootstrap.zip" onclick="_gaq.push(['_trackEvent', 'Getting started', 'Download', 'Download compiled']);">Download Bootstrap</a></p>
      </div>
      <div class="col-span-6">
30
        <h3>Latest source code</h3>
31
32
33
34
        <p>Get the original files for all CSS and JavaScript, along with a local copy of the docs by downloading the latest version directly from GitHub.</p>
        <p><a class="btn btn-large" href="https://github.com/twitter/bootstrap/zipball/master" onclick="_gaq.push(['_trackEvent', 'Getting started', 'Download', 'Download source']);">Download Bootstrap source</a></p>
      </div>
      <div class="col-span-6">
35
36
37
38
39
40
        <h3>Clone or fork via GitHub</h3>
        <p>Clone the entire project or fork your own version of Bootstrap to make it your own by visiting us on GitHub.</p>
        <p><a class="btn btn-large" href="https://github.com/twitter/bootstrap/" onclick="_gaq.push(['_trackEvent', 'Getting started', 'Download', 'GitHub project']);">GitHub repository</a></p>
      </div>
      <div class="col-span-6">
        <h3>Bower</h3>
41
        <p>Install and manage the original files for all CSS and JavaScript, along with a local copy of the docs, using <a href="http://twitter.github.com/bower">Bower</a>.</p>
42
        {% highlight bash %}$ bower install bootstrap{% endhighlight %}
43
44
      </div>
    </div>
45
  </div>
46
47
48

  <!-- File structure
  ================================================== -->
49
  <div class="bs-docs-section" id="whats-included">
50
    <div class="page-header">
51
      <h1>What's included</h1>
52
    </div>
53
    <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>
54
    <p>Once downloaded, unzip the compressed folder to see the structure of (the compiled) Bootstrap. You'll see something like this:</p>
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

{% highlight bash %}
  bootstrap/
  ├── css/
  │   ├── bootstrap.css
  │   ├── bootstrap.min.css
  ├── js/
  │   ├── bootstrap.js
  │   ├── bootstrap.min.js
  └── fonts/
      ├── glyphiconshalflings-regular.eot
      ├── glyphiconshalflings-regular.otf
      ├── glyphiconshalflings-regular.svg
      ├── glyphiconshalflings-regular.ttf
      └── glyphiconshalflings-regular.woff
{% endhighlight %}

72
73
    <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>). The image files are compressed using <a href="http://imageoptim.com/">ImageOptim</a>, a Mac app for compressing PNGs.</p>
    <p>Please note that <strong>all JavaScript plugins require jQuery</strong> to be included.</p>
74
  </div>
75

76
  <!-- Examples
77
  ================================================== -->
78
  <div class="bs-docs-section" id="examples">
79
    <div class="page-header">
80
      <h1>Templates and examples</h1>
81
    </div>
82
    <p class="lead">Make use of a super basic HTML template, or dive into a few examples we've started for you. We encourage folks to iterate on these examples and not simply use them as an end result.</p>
83

84
    <h3>HTML template</h3>
85
    <p>Copy and paste the HTML from below to get started with a bare bones Bootstrap document.</p>
86
87
88
89
90
91
92
93
94
95
96
{% highlight html linenos %}
<!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>
97
98

    <!-- JavaScript plugins (requires jQuery) -->
99
    <script src="http://code.jquery.com/jquery.js"></script>
100
    <!-- Include all compiled plugins (below), or include individual files as needed -->
101
    <script src="js/bootstrap.min.js"></script>
102
103
104

    <!-- Optionally enable responsive features in IE8 -->
    <script src="js/respond.js"></script>
105
106
107
108
  </body>
</html>
{% endhighlight %}

109
    <h3>Examples</h3>
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
    <div class="row bs-docs-examples">
      <div class="col-span-4">
        <a class="thumbnail" href="/examples/starter-template/" target="_blank">
          <img src="/assets/img/examples/bootstrap-example-starter.png" alt="">
        </a>
        <h4>Starter template</h4>
        <p>A barebones HTML document with all the Bootstrap CSS and JavaScript included.</p>
      </div>
      <div class="col-span-4">
        <a class="thumbnail" href="/examples/jumbotron/" target="_blank">
          <img src="/assets/img/examples/bootstrap-example-marketing.png" alt="">
        </a>
        <h4>Basic marketing site</h4>
        <p>Featuring a hero unit for a primary message and three supporting elements.</p>
      </div>
      <div class="col-span-4">
        <a class="thumbnail" href="/examples/jumbotron-narrow/" target="_blank">
          <img src="/assets/img/examples/bootstrap-example-jumbotron-narrow.png" alt="">
        </a>
        <h4>Narrow marketing</h4>
        <p>Slim, lightweight marketing template for small projects or teams.</p>
      </div>
      <div class="col-span-4">
        <a class="thumbnail" href="/examples/justified-nav/" target="_blank">
          <img src="/assets/img/examples/bootstrap-example-justified-nav.png" alt="">
        </a>
        <h4>Justified nav</h4>
        <p>Marketing page with equal-width navigation links in a modified navbar.</p>
      </div>
      <div class="col-span-4">
        <a class="thumbnail" href="/examples/signin/" target="_blank">
          <img src="/assets/img/examples/bootstrap-example-signin.png" alt="">
        </a>
        <h4>Sign in</h4>
        <p>Barebones sign in form with custom, larger form controls and a flexible layout.</p>
      </div>
      <div class="col-span-4">
        <a class="thumbnail" href="/examples/sticky-footer/" target="_blank">
          <img src="/assets/img/examples/bootstrap-example-sticky-footer.png" alt="">
        </a>
        <h4>Sticky footer</h4>
        <p>Pin a fixed-height footer to the bottom of the user's viewport.</p>
      </div>
      <div class="col-span-4">
        <a class="thumbnail" href="/examples/sticky-footer-navbar/" target="_blank">
          <img src="/assets/img/examples/bootstrap-example-sticky-footer-navbar.png" alt="">
        </a>
        <h4>Sticky footer w/ navbar</h4>
        <p>Add a fixed navbar to the default sticky footer template.</p>
      </div>
      <div class="col-span-4">
        <a class="thumbnail" href="/examples/carousel/" target="_blank">
          <img src="/assets/img/examples/bootstrap-example-carousel.png" alt="">
        </a>
        <h4>Carousel jumbotron</h4>
        <p>An interactive riff on the basic marketing site featuring a prominent carousel.</p>
      </div>

      <div class="col-span-4">
        <a class="thumbnail" href="/examples/navbar/" target="_blank">
          <img src="/assets/img/examples/bootstrap-example-navbar.png" alt="">
        </a>
        <h4>Navbar</h4>
        <p>Basic template for showcasing how the navbar works.</p>
      </div>
      <div class="col-span-4">
        <a class="thumbnail" href="/examples/navbar-static-top/" target="_blank">
          <img src="/assets/img/examples/bootstrap-example-navbar-static-top.png" alt="">
        </a>
        <h4>Static top navbar</h4>
        <p>Basic template for showcasing the static navbar variation.</p>
      </div>
      <div class="col-span-4">
        <a class="thumbnail" href="/examples/navbar-fixed-top/" target="_blank">
          <img src="/assets/img/examples/bootstrap-example-navbar-fixed-top.png" alt="">
        </a>
        <h4>Fixed top navbar</h4>
        <p>Basic template for showcasing the fixed navbar variation.</p>
      </div>
    </div>
190
  </div>
191
192
193
194
195





196
  <div class="bs-docs-section-header" id="css">
197
198
199
    <h1>CSS</h1>
    <p class="lead">Fundamental HTML elements styled and enhanced with extensible classes.</p>
  </div>
200

201
202
203
204
205
206
207
  <!-- Global Bootstrap settings
  ================================================== -->
  <div class="bs-docs-section" id="css-overview">
    <div class="page-header">
      <h1>Overview</h1>
    </div>
    <p class="lead">Get the lowdown on the key pieces of Bootstrap's infrastructure, including our approach to better, faster, stronger web development.</p>
208

209
210
    <h3>HTML5 doctype required</h3>
    <p>Bootstrap makes use of certain HTML elements and CSS properties that require the use of the HTML5 doctype. Include it at the beginning of all your projects.</p>
211
212
213
214
215
216
217
{% highlight html linenos %}
<!DOCTYPE html>
<html lang="en">
  ...
</html>
{% endhighlight %}

218
219
220
    <h3>Mobile first</h3>
    <p>With Bootstrap 2, we added optional mobile friendly styles for key aspects of the framework. With Bootstrap 3, we've rewritten the project to be mobile friendly from the start. Instead of adding on optional mobile styles, they're baked right into the core. In fact, <strong>Bootstrap is mobile first</strong>. Mobile first styles can be found throughout the entire library instead of in separate files.</p>
    <p>To ensure proper rendering and touch zooming, <strong>add the viewport meta tag</strong> to your <code>&lt;head&gt;</code>.</p>
221
222
223
224
{% highlight html linenos %}
<meta name="viewport" content="width=device-width, initial-scale=1.0">
{% endhighlight %}

225
226
227
    <h3>Responsive images</h3>
    <p>We automatically attempt to scale images to appropriate sizes with a global <code>max-width: 100%;</code> on all <code>&lt;img&gt;</code> elements. If you run into problems (e.g., with Google Maps), be sure to disable this property on a per-case basis.</p>

228
229
230
231
232
233
234
235
236
    <h3>Typography and links</h3>
    <p>Bootstrap sets basic global display, typography, and link styles. Specifically, we:</p>
    <ul>
      <li>Remove <code>margin</code> on the body</li>
      <li>Set <code>background-color: white;</code> on the <code>body</code></li>
      <li>Use the <code>@font-family-base</code>, <code>@font-size-base</code>, and <code>@line-height-base</code> attributes as our typographic base</li>
      <li>Set the global link color via <code>@link-color</code> and apply link underlines only on <code>:hover</code></li>
    </ul>
    <p>These styles can be found within <strong>scaffolding.less</strong>.</p>
237

238
239
240
    <h3>Normalize reset</h3>
    <p>For improved cross-browser rendering, we use <a href="http://necolas.github.com/normalize.css/" target="_blank">Normalize</a>, a project by <a href="http://twitter.com/necolas" target="_blank">Nicolas Gallagher</a> and <a href="http://twitter.com/jon_neal" target="_blank">Jonathan Neal</a>.</p>
  </div>
241

242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
  <!-- Grid system
  ================================================== -->
  <div class="bs-docs-section" id="grid">
    <div class="page-header">
      <h1>Grid system</h1>
    </div>
    <p class="lead">Bootstrap includes a responsive, percent-based grid system that appropriately scales up to 12 columns as the device or viewport size increases&mdash;in other words, it's mobile first. It includes <a href="#grid-example">predefined classes</a> for this, as well as powerful <a href="#grid-less">mixins for generating semantic layouts</a>.</p>

    <h3 id="grid-example">Grid example</h3>
    <p>On mobile devices, the grid starts out stacked. Above 768px, it becomes horizontal as media queries kick in to apply <code>float</code>s and <code>width</code>s. To create a basic grid layout, wrap a series of <code>.col-span-*</code> elements within a <code>.row</code>. As this is a 12-column grid, each <code>.span*</code> spans a number of those 12 columns, and should always add up to 12 for each row (or the number of columns in the parent), even at mobile resolutions.</p>
    <div class="bs-docs-grid">
      <div class="row show-grid">
        <div class="col-span-1">1</div>
        <div class="col-span-1">1</div>
        <div class="col-span-1">1</div>
        <div class="col-span-1">1</div>
        <div class="col-span-1">1</div>
        <div class="col-span-1">1</div>
        <div class="col-span-1">1</div>
        <div class="col-span-1">1</div>
        <div class="col-span-1">1</div>
        <div class="col-span-1">1</div>
        <div class="col-span-1">1</div>
        <div class="col-span-1">1</div>
      </div>
      <div class="row show-grid">
        <div class="col-span-4">4</div>
        <div class="col-span-4">4</div>
        <div class="col-span-4">4</div>
      </div>
      <div class="row show-grid">
        <div class="col-span-6">6</div>
        <div class="col-span-6">6</div>
      </div>
    </div>
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
{% highlight html linenos %}
<div class="row">
  <div class="col-span-1">1</div>
  <div class="col-span-1">1</div>
  <div class="col-span-1">1</div>
  <div class="col-span-1">1</div>
  <div class="col-span-1">1</div>
  <div class="col-span-1">1</div>
  <div class="col-span-1">1</div>
  <div class="col-span-1">1</div>
  <div class="col-span-1">1</div>
  <div class="col-span-1">1</div>
  <div class="col-span-1">1</div>
  <div class="col-span-1">1</div>
</div>
<div class="row">
  <div class="col-span-4">4</div>
  <div class="col-span-4">4</div>
  <div class="col-span-4">4</div>
</div>
<div class="row">
  <div class="col-span-6">6</div>
  <div class="col-span-6">6</div>
</div>
{% endhighlight %}

303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
    <h3 id="grid-offsetting">Offsetting columns</h3>
    <p>Move columns to the right using <code>.col-offset-*</code> classes. Each class increases the left margin of a column by a whole column. For example, <code>.col-offset-4</code> moves <code>.col-span-4</code> over four columns.</p>
    <div class="bs-docs-grid">
      <div class="row show-grid">
        <div class="col-span-4">4</div>
        <div class="col-span-4 col-offset-4">4 offset 4</div>
      </div><!-- /row -->
      <div class="row show-grid">
        <div class="col-span-3 col-offset-3">3 offset 3</div>
        <div class="col-span-3 col-offset-3">3 offset 3</div>
      </div><!-- /row -->
      <div class="row show-grid">
        <div class="col-span-6 col-offset-6">6 offset 6</div>
      </div><!-- /row -->
    </div>
318
319
320
321
322
323
324
325
{% highlight html linenos %}
<div class="row">
  <div class="col-span-4">...</div>
  <div class="col-span-4 col-offset-4">...</div>
</div>
{% endhighlight %}


326
327
328
329
330
331
332
333
334
335
336
    <h3 id="grid-nesting">Nesting columns</h3>
    <p>To nest your content with the default grid, add a new <code>.row</code> and set of <code>.span*</code> columns within an existing <code>.span*</code> column. Nested rows should include a set of columns that add up to 12.</p>
    <div class="row show-grid">
      <div class="col-span-9">
        Level 1: 9 columns
        <div class="row show-grid">
          <div class="col-span-6">
            Level 2: 6 columns
          </div>
          <div class="col-span-6">
            Level 2: 6 columns
337
          </div>
338
339
340
        </div>
      </div>
    </div>
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
{% highlight html linenos %}
<div class="row">
  <div class="col-span-9">
    Level 1: 9 columns
    <div class="row">
      <div class="col-span-6">
        Level 2: 6 columns
      </div>
      <div class="col-span-6">
        Level 2: 6 columns
      </div>
    </div>
  </div>
</div>
{% endhighlight %}

357
358
    <h3 id="grid-column-ordering">Column ordering</h3>
    <p>Easily change the order of our built-in grid columns with <code>.push*</code> and <code>.pull*</code> modifier classes.</p>
359
360
361
362
363
364
365
366
367
368
369
370
<div class="row show-grid">
  <div class="col-span-9 col-push-3">9</div>
  <div class="col-span-3 col-pull-9">3</div>
</div>

{% highlight html linenos %}
<div class="row show-grid">
  <div class="col-span-9 col-push-3">9</div>
  <div class="col-span-3 col-pull-9">3</div>
</div>
{% endhighlight %}

371
372
    <h3 id="grid-less">LESS mixins and variables</h3>
    <p>In addition to <a href="#grid-example">prebuilt grid classes</a> for fast layouts, Bootstrap includes LESS variables and mixins for quickly generating your own simple, semantic layouts.</p>
373

374
375
    <h4>Variables</h4>
    <p>Variables determine the number of columns, the gutter width, and the media query point at which to begin floating columns. We use these to generate the predefined grid classes documented above, as well as for the custom mixins listed below.</p>
376
377
378
379
380
381
{% highlight css linenos %}
@grid-columns:              12;
@grid-gutter-width:         30px;
@grid-float-breakpoint:     768px;
{% endhighlight %}

382
383
    <h4>Mixins</h4>
    <p>Mixins are used in conjunction with the grid variables to generate semantic CSS for individual grid columns.</p>
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
{% highlight css linenos %}
// Creates a wrapper for a series of columns
.make-row() {
  // Negative margin the row out to align the content of columns
  margin-left:  (@grid-gutter-width / -2);
  margin-right: (@grid-gutter-width / -2);
  // Then clear the floated columns
  .clear_float();
}

// Generate the columns
.make-column(@columns) {
  @media (min-width: @grid-float-breakpoint) {
    float: left;
    // Calculate width based on number of columns available
    width: percentage(@columns / @grid-columns);
  }
  // Prevent columns from collapsing when empty
  min-height: 1px;
  // Set inner padding as gutters instead of margin
  padding-left:  (@grid-gutter-width / 2);
  padding-right: (@grid-gutter-width / 2);
}

// Generate the column offsets
.make-column-offset(@columns) {
  @media (min-width: @grid-float-breakpoint) {
    margin-left: percentage((@columns / @grid-columns));
  }
}
{% endhighlight %}

416
417
    <h4>Example usage</h4>
    <p>You can modify the variables to your own custom values, or just use the mixins with their default values. Here's an example of using the default settings to create a two-column layout with a gap between.</p>
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
{% highlight css linenos %}
.wrapper {
  .make-row();
}
.content-main {
  .make-column(8);
}
.content-secondary {
  .make-column(3);
  .make-column-offset(1);
}
{% endhighlight %}
{% highlight html linenos %}
<div class="wrapper">
  <div class="content-main">...</div>
  <div class="content-secondary">...</div>
</div>
{% endhighlight %}

437
  </div>
438
439
440
441




442
443
444
445
446
447
  <!-- Typography
  ================================================== -->
  <div class="bs-docs-section" id="type">
    <div class="page-header">
      <h1>Typography</h1>
    </div>
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
475
476
477
478
479
480
481
482
    <!-- Headings -->
    <h2 id="type-headings">Headings</h2>
    <p>All HTML headings, <code>&lt;h1&gt;</code> through <code>&lt;h6&gt;</code> are available.</p>

    <div class="bs-docs-example bs-docs-example-type">
      <table class="table">
        <tbody>
          <tr>
            <th><h1>Bootstrap heading</h1></th>
            <td>Semibold 38px</td>
          </tr>
          <tr>
            <th><h2>Bootstrap heading</h2></th>
            <td>Semibold 32px</td>
          </tr>
          <tr>
            <th><h3>Bootstrap heading</h3></th>
            <td>Semibold 24px</td>
          </tr>
          <tr>
            <th><h4>Bootstrap heading</h4></th>
            <td>Semibold 18px</td>
          </tr>
          <tr>
            <th><h5>Bootstrap heading</h5></th>
            <td>Semibold 16px</td>
          </tr>
          <tr>
            <th><h6>Bootstrap heading</h6></th>
            <td>Semibold 12px</td>
          </tr>
        </tbody>
      </table>
    </div>
Mark Otto's avatar
Mark Otto committed
483
484
485
486
487
488
489
490
{% highlight html linenos %}
<h1>...</h1>
<h2>...</h2>
<h3>...</h3>
<h4>...</h4>
<h5>...</h5>
<h6>...</h6>
{% endhighlight %}
491

492
493
494
495
496
497
498
499
    <!-- Body copy -->
    <h2 id="type-body-copy">Body copy</h2>
    <p>Bootstrap's global default <code>font-size</code> is <strong>14px</strong>, with a <code>line-height</code> of <strong>20px</strong>. This is applied to the <code>&lt;body&gt;</code> and all paragraphs. In addition, <code>&lt;p&gt;</code> (paragraphs) receive a bottom margin of half their line-height (10px by default).</p>
    <div class="bs-docs-example">
      <p>Nullam quis risus eget urna mollis ornare vel eu leo. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Nullam id dolor id nibh ultricies vehicula.</p>
      <p>Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec ullamcorper nulla non metus auctor fringilla. Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit. Donec ullamcorper nulla non metus auctor fringilla.</p>
      <p>Maecenas sed diam eget risus varius blandit sit amet non magna. Donec id elit non mi porta gravida at eget metus. Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit.</p>
    </div>
500
501
502
503
{% highlight html linenos %}
<p>...</p>
{% endhighlight %}

504
505
506
507
508
509
    <!-- Body copy .lead -->
    <h3>Lead body copy</h3>
    <p>Make a paragraph stand out by adding <code>.lead</code>.</p>
    <div class="bs-docs-example">
      <p class="lead">Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor. Duis mollis, est non commodo luctus.</p>
    </div>
510
511
512
513
{% highlight html linenos %}
<p class="lead">...</p>
{% endhighlight %}

514
515
516
    <!-- Using LESS -->
    <h3>Built with Less</h3>
    <p>The typographic scale is based on two LESS variables in <strong>variables.less</strong>: <code>@font-size-base</code> and <code>@line-height-base</code>. The first is the base font-size used throughout and the second is the base line-height. We use those variables and some simple math to create the margins, paddings, and line-heights of all our type and more. Customize them and Bootstrap adapts.</p>
517
518


519
520
521
    <!-- Emphasis -->
    <h2 id="type-emphasis">Emphasis</h2>
    <p>Make use of HTML's default emphasis tags with lightweight styles.</p>
522

523
524
525
526
527
    <h3>Small text</h3>
    <p>For de-emphasizing inline or blocks of text, <small>use the small tag</small> to set text at 85% the size of the parent. Heading elements receive their own <code>font-size</code> for nested <code>&lt;small&lt;</code> elements.</p>
    <div class="bs-docs-example">
      <p><small>This line of text is meant to be treated as fine print.</small></p>
    </div>
528
529
530
531
532
{% highlight html linenos %}
<small>This line of text is meant to be treated as fine print.</small>
{% endhighlight %}


533
534
535
536
537
    <h3>Bold</h3>
    <p>For emphasizing a snippet of text with a heavier font-weight.</p>
    <div class="bs-docs-example">
      <p>The following snippet of text is <strong>rendered as bold text</strong>.</p>
    </div>
538
539
540
541
{% highlight html linenos %}
<strong>rendered as bold text</strong>
{% endhighlight %}

542
543
544
545
546
    <h3>Italics</h3>
    <p>For emphasizing a snippet of text with italics.</p>
    <div class="bs-docs-example">
      <p>The following snippet of text is <em>rendered as italicized text</em>.</p>
    </div>
547
548
549
550
{% highlight html linenos %}
<em>rendered as italicized text</em>
{% endhighlight %}

551
    <p>Feel free to use <code>&lt;b&gt;</code> and <code>&lt;i&gt;</code> in HTML5. <code>&lt;b&gt;</code> is meant to highlight words or phrases without conveying additional importance while <code>&lt;i&gt;</code> is mostly for voice, technical terms, etc.</p>
552

553
554
555
556
557
558
559
    <h3>Alignment classes</h3>
    <p>Easily realign text to components with text alignment classes.</p>
    <div class="bs-docs-example">
      <p class="text-left">Left aligned text.</p>
      <p class="text-center">Center aligned text.</p>
      <p class="text-right">Right aligned text.</p>
    </div>
560
561
562
563
564
565
{% highlight html linenos %}
<p class="text-left">Left aligned text.</p>
<p class="text-center">Center aligned text.</p>
<p class="text-right">Right aligned text.</p>
{% endhighlight %}

566
567
568
569
570
571
572
573
    <h3>Emphasis classes</h3>
    <p>Convey meaning through color with a handful of emphasis utility classes.</p>
    <div class="bs-docs-example">
      <p class="text-muted">Fusce dapibus, tellus ac cursus commodo, tortor mauris nibh.</p>
      <p class="text-warning">Etiam porta sem malesuada magna mollis euismod.</p>
      <p class="text-error">Donec ullamcorper nulla non metus auctor fringilla.</p>
      <p class="text-success">Duis mollis, est non commodo luctus, nisi erat porttitor ligula.</p>
    </div>
574
{% highlight html linenos %}
Mark Otto's avatar
Mark Otto committed
575
<p class="text-muted">...</p>
576
577
578
579
580
581
<p class="text-warning">...</p>
<p class="text-error">...</p>
<p class="text-success">...</p>
{% endhighlight %}


582
583
584
    <!-- Abbreviations -->
    <h2 id="type-abbreviations">Abbreviations</h2>
    <p>Stylized implementation of HTML's <code>&lt;abbr&gt;</code> element for abbreviations and acronyms to show the expanded version on hover. Abbreviations with a <code>title</code> attribute have a light dotted bottom border and a help cursor on hover, providing additional context on hover.</p>
585

586
587
588
589
590
    <h3>Basic abbreviation</h3>
    <p>For expanded text on long hover of an abbreviation, include the <code>title</code> attribute with the <code>&lt;abbr&gt;</code> element.</p>
    <div class="bs-docs-example">
      <p>An abbreviation of the word attribute is <abbr title="attribute">attr</abbr>.</p>
    </div>
591
592
593
594
{% highlight html linenos %}
<abbr title="attribute">attr</abbr>
{% endhighlight %}

595
596
597
598
599
    <h3>Initialism</h3>
    <p>Add <code>.initialism</code> to an abbreviation for a slightly smaller font-size.</p>
    <div class="bs-docs-example">
      <p><abbr title="HyperText Markup Language" class="initialism">HTML</abbr> is the best thing since sliced bread.</p>
    </div>
600
601
602
603
604
{% highlight html linenos %}
<abbr title="HyperText Markup Language" class="initialism">HTML</abbr>
{% endhighlight %}


605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
    <!-- Addresses -->
    <h2 id="type-addresses">Addresses</h2>
    <p>Present contact information for the nearest ancestor or the entire body of work. Preserve formatting by ending all lines with <code>&lt;br&gt;</code>.</p>
    <div class="bs-docs-example">
      <address>
        <strong>Twitter, Inc.</strong><br>
        795 Folsom Ave, Suite 600<br>
        San Francisco, CA 94107<br>
        <abbr title="Phone">P:</abbr> (123) 456-7890
      </address>
      <address>
        <strong>Full Name</strong><br>
        <a href="mailto:#">first.last@example.com</a>
      </address>
    </div>
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
{% highlight html linenos %}
<address>
  <strong>Twitter, Inc.</strong><br>
  795 Folsom Ave, Suite 600<br>
  San Francisco, CA 94107<br>
  <abbr title="Phone">P:</abbr> (123) 456-7890
</address>

<address>
  <strong>Full Name</strong><br>
  <a href="mailto:#">first.last@example.com</a>
</address>
{% endhighlight %}


635
636
637
    <!-- Blockquotes -->
    <h2 id="type-blockquotes">Blockquotes</h2>
    <p>For quoting blocks of content from another source within your document.</p>
638

639
640
641
642
643
644
645
    <h3>Default blockquote</h3>
    <p>Wrap <code>&lt;blockquote&gt;</code> around any <abbr title="HyperText Markup Language">HTML</abbr> as the quote. For straight quotes we recommend a <code>&lt;p&gt;</code>.</p>
    <div class="bs-docs-example">
      <blockquote>
        <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.</p>
      </blockquote>
    </div>
646
647
648
649
650
651
{% highlight html linenos %}
<blockquote>
  <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.</p>
</blockquote>
{% endhighlight %}

652
653
    <h3>Blockquote options</h3>
    <p>Style and content changes for simple variations on a standard blockquote.</p>
654

655
656
657
658
659
660
661
662
    <h4>Naming a source</h4>
    <p>Add <code>&lt;small&gt;</code> tag for identifying the source. Wrap the name of the source work in <code>&lt;cite&gt;</code>.</p>
    <div class="bs-docs-example">
      <blockquote>
        <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.</p>
        <small>Someone famous in <cite title="Source Title">Source Title</cite></small>
      </blockquote>
    </div>
663
664
665
666
667
668
669
{% highlight html linenos %}
<blockquote>
  <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.</p>
  <small>Someone famous <cite title="Source Title">Source Title</cite></small>
</blockquote>
{% endhighlight %}

670
671
672
673
674
675
676
677
    <h4>Alternate displays</h4>
    <p>Use <code>.pull-right</code> for a floated, right-aligned blockquote.</p>
    <div class="bs-docs-example" style="overflow: hidden;">
      <blockquote class="pull-right">
        <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.</p>
        <small>Someone famous in <cite title="Source Title">Source Title</cite></small>
      </blockquote>
    </div>
678
679
680
681
682
683
684
{% highlight html linenos %}
<blockquote class="pull-right">
  ...
</blockquote>
{% endhighlight %}


685
686
    <!-- Lists -->
    <h2 id="type-lists">Lists</h2>
687

688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
    <h3>Unordered</h3>
    <p>A list of items in which the order does <em>not</em> explicitly matter.</p>
    <div class="bs-docs-example">
      <ul>
        <li>Lorem ipsum dolor sit amet</li>
        <li>Consectetur adipiscing elit</li>
        <li>Integer molestie lorem at massa</li>
        <li>Facilisis in pretium nisl aliquet</li>
        <li>Nulla volutpat aliquam velit
          <ul>
            <li>Phasellus iaculis neque</li>
            <li>Purus sodales ultricies</li>
            <li>Vestibulum laoreet porttitor sem</li>
            <li>Ac tristique libero volutpat at</li>
          </ul>
        </li>
        <li>Faucibus porta lacus fringilla vel</li>
        <li>Aenean sit amet erat nunc</li>
        <li>Eget porttitor lorem</li>
      </ul>
    </div>
709
710
711
712
713
714
{% highlight html linenos %}
<ul>
  <li>...</li>
</ul>
{% endhighlight %}

715
716
717
718
719
720
721
722
723
724
725
726
727
728
    <h3>Ordered</h3>
    <p>A list of items in which the order <em>does</em> explicitly matter.</p>
    <div class="bs-docs-example">
      <ol>
        <li>Lorem ipsum dolor sit amet</li>
        <li>Consectetur adipiscing elit</li>
        <li>Integer molestie lorem at massa</li>
        <li>Facilisis in pretium nisl aliquet</li>
        <li>Nulla volutpat aliquam velit</li>
        <li>Faucibus porta lacus fringilla vel</li>
        <li>Aenean sit amet erat nunc</li>
        <li>Eget porttitor lorem</li>
      </ol>
    </div>
729
730
731
732
733
734
{% highlight html linenos %}
<ol>
  <li>...</li>
</ol>
{% endhighlight %}

735
736
737
738
739
740
741
742
743
744
745
746
747
748
    <h3>Unstyled</h3>
    <p>Remove the default <code>list-style</code> and left margin on list items (immediate children only). <strong>This only applies to immediate children list items</strong>, meaning you will need to add the class for any nested lists as well.</p>
    <div class="bs-docs-example">
      <ul class="list-unstyled">
        <li>Lorem ipsum dolor sit amet</li>
        <li>Consectetur adipiscing elit</li>
        <li>Integer molestie lorem at massa</li>
        <li>Facilisis in pretium nisl aliquet</li>
        <li>Nulla volutpat aliquam velit
          <ul>
            <li>Phasellus iaculis neque</li>
            <li>Purus sodales ultricies</li>
            <li>Vestibulum laoreet porttitor sem</li>
            <li>Ac tristique libero volutpat at</li>
749
          </ul>
750
751
752
753
754
755
        </li>
        <li>Faucibus porta lacus fringilla vel</li>
        <li>Aenean sit amet erat nunc</li>
        <li>Eget porttitor lorem</li>
      </ul>
    </div>
756
757
758
759
760
761
{% highlight html linenos %}
<ul class="list-unstyled">
  <li>...</li>
</ul>
{% endhighlight %}

762
763
764
765
766
767
768
769
770
    <h3>Inline</h3>
    <p>Place all list items on a single line with <code>inline-block</code> and some light padding.</p>
    <div class="bs-docs-example">
      <ul class="list-inline">
        <li>Lorem ipsum</li>
        <li>Phasellus iaculis</li>
        <li>Nulla volutpat</li>
      </ul>
    </div>
771
772
773
774
775
776
{% highlight html linenos %}
<ul class="list-inline">
  <li>...</li>
</ul>
{% endhighlight %}

777
778
779
780
781
782
783
784
785
786
787
788
789
    <h3>Description</h3>
    <p>A list of terms with their associated descriptions.</p>
    <div class="bs-docs-example">
      <dl>
        <dt>Description lists</dt>
        <dd>A description list is perfect for defining terms.</dd>
        <dt>Euismod</dt>
        <dd>Vestibulum id ligula porta felis euismod semper eget lacinia odio sem nec elit.</dd>
        <dd>Donec id elit non mi porta gravida at eget metus.</dd>
        <dt>Malesuada porta</dt>
        <dd>Etiam porta sem malesuada magna mollis euismod.</dd>
      </dl>
    </div>
790
791
792
793
794
795
796
{% highlight html linenos %}
<dl>
  <dt>...</dt>
  <dd>...</dd>
</dl>
{% endhighlight %}

797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
    <h4>Horizontal description</h4>
    <p>Make terms and descriptions in <code>&lt;dl&gt;</code> line up side-by-side.</p>
    <div class="bs-docs-example">
      <dl class="dl-horizontal">
        <dt>Description lists</dt>
        <dd>A description list is perfect for defining terms.</dd>
        <dt>Euismod</dt>
        <dd>Vestibulum id ligula porta felis euismod semper eget lacinia odio sem nec elit.</dd>
        <dd>Donec id elit non mi porta gravida at eget metus.</dd>
        <dt>Malesuada porta</dt>
        <dd>Etiam porta sem malesuada magna mollis euismod.</dd>
        <dt>Felis euismod semper eget lacinia</dt>
        <dd>Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus.</dd>
      </dl>
    </div>
812
813
814
815
816
817
818
{% highlight html linenos %}
<dl class="dl-horizontal">
  <dt>...</dt>
  <dd>...</dd>
</dl>
{% endhighlight %}

819
820
821
822
823
    <h5>Auto-truncating</h5>
    <p>
      Horizontal description lists will truncate terms that are too long to fit in the left column fix <code>text-overflow</code>. In narrower viewports, they will change to the default stacked layout.
    </p>
  </div>
824
825


826
827
828
829
830
831
  <!-- Code
  ================================================== -->
  <div class="bs-docs-section" id="code">
    <div class="page-header">
      <h1>Code</h1>
    </div>
832

833
834
    <h2>Inline</h2>
    <p>Wrap inline snippets of code with <code>&lt;code&gt;</code>.</p>
835
836
837
838
839
840
841
<div class="bs-docs-example">
  For example, <code>&lt;section&gt;</code> should be wrapped as inline.
</div>
{% highlight html linenos %}
For example, <code>&lt;section&gt;</code> should be wrapped as inline.
{% endhighlight %}

842
843
    <h2>Basic block</h2>
    <p>Use <code>&lt;pre&gt;</code> for multiple lines of code. Be sure to escape any angle brackets in the code for proper rendering.</p>
844
845
846
847
848
849
850
<div class="bs-docs-example">
  <pre>&lt;p&gt;Sample text here...&lt;/p&gt;</pre>
</div>
{% highlight html linenos %}
<pre>&lt;p&gt;Sample text here...&lt;/p&gt;</pre>
{% endhighlight %}

851
852
    <p>You may optionally add the <code>.pre-scrollable</code> class which will set a max-height of 350px and provide a y-axis scrollbar.</p>
  </div>
853
854
855



856
857
858
859
860
861
  <!-- Tables
  ================================================== -->
  <div class="bs-docs-section" id="tables">
    <div class="page-header">
      <h1>Tables</h1>
    </div>
862

863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
    <h2 id="tables-example">Basic example</h2>
    <p>For basic styling&mdash;light padding and only horizontal dividers&mdash;add the base class <code>.table</code> to any <code>&lt;table&gt;</code>. It may seem super redundant, but given the widespread use of tables for other plugins like calendars and date pickers, we've opted to isolate our custom table styles.</p>
    <div class="bs-docs-example">
      <table class="table">
        <thead>
          <tr>
            <th>#</th>
            <th>First Name</th>
            <th>Last Name</th>
            <th>Username</th>
          </tr>
        </thead>
        <tbody>
          <tr>
            <td>1</td>
            <td>Mark</td>
            <td>Otto</td>
            <td>@mdo</td>
          </tr>
          <tr>
            <td>2</td>
            <td>Jacob</td>
            <td>Thornton</td>
            <td>@fat</td>
          </tr>
          <tr>
            <td>3</td>
            <td>Larry</td>
            <td>the Bird</td>
            <td>@twitter</td>
          </tr>
        </tbody>
      </table>
    </div><!-- /example -->
897
898
899
900
901
902
903
{% highlight html linenos %}
<table class="table">
  ...
</table>
{% endhighlight %}


904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
    <h2>Optional classes</h2>
    <p>Add any of the following classes to the <code>.table</code> base class.</p>

    <h3 id="tables-striped">Striped</h3>
    <p>Use <code>.table-striped</code> to add zebra-striping to any table row within the <code>&lt;tbody&gt;</code> via the <code>:nth-child</code> CSS selector (not available in IE8).</p>
    <div class="bs-docs-example">
      <table class="table table-striped">
        <thead>
          <tr>
            <th>#</th>
            <th>First Name</th>
            <th>Last Name</th>
            <th>Username</th>
          </tr>
        </thead>
        <tbody>
          <tr>
            <td>1</td>
            <td>Mark</td>
            <td>Otto</td>
            <td>@mdo</td>
          </tr>
          <tr>
            <td>2</td>
            <td>Jacob</td>
            <td>Thornton</td>
            <td>@fat</td>
          </tr>
          <tr>
            <td>3</td>
            <td>Larry</td>
            <td>the Bird</td>
            <td>@twitter</td>
          </tr>
        </tbody>
      </table>
    </div><!-- /example -->
941
942
943
944
945
946
{% highlight html linenos %}
<table class="table table-striped">
  ...
</table>
{% endhighlight %}

947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
    <h3 id="tables-bordered">Bordered</h3>
    <p>Add <code>.table-bordered</code> for borders and rounded corners.</p>
    <div class="bs-docs-example">
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>#</th>
            <th>First Name</th>
            <th>Last Name</th>
            <th>Username</th>
          </tr>
        </thead>
        <tbody>
          <tr>
            <td rowspan="2">1</td>
            <td>Mark</td>
            <td>Otto</td>
            <td>@mdo</td>
          </tr>
          <tr>
            <td>Mark</td>
            <td>Otto</td>
            <td>@TwBootstrap</td>
          </tr>
          <tr>
            <td>2</td>
            <td>Jacob</td>
            <td>Thornton</td>
            <td>@fat</td>
          </tr>
          <tr>
            <td>3</td>
            <td colspan="2">Larry the Bird</td>
            <td>@twitter</td>
          </tr>
        </tbody>
      </table>
    </div><!-- /example -->
985
986
987
988
989
990
{% highlight html linenos %}
<table class="table table-bordered">
  ...
</table>
{% endhighlight %}

991
992
993
994
995
996
997
998
999
1000
    <h3 id="tables-hover-rows">Hover rows</h3>
    <p>Add <code>.table-hover</code> to enable a hover state on table rows within a <code>&lt;tbody&gt;</code>.</p>
    <div class="bs-docs-example">
      <table class="table table-hover">
        <thead>
          <tr>
            <th>#</th>
            <th>First Name</th>
            <th>Last Name</th>
            <th>Username</th>
For faster browsing, not all history is shown. View entire blame