getting-started.html 17 KB
Newer Older
1
2
3
4
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
5
    <title>Getting · Bootstrap</title>
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta name="description" content="">
    <meta name="author" content="">

    <!-- Le styles -->
    <link href="assets/css/bootstrap.css" rel="stylesheet">
    <link href="assets/css/docs.css" rel="stylesheet">
    <link href="assets/js/google-code-prettify/prettify.css" rel="stylesheet">

    <!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
    <!--[if lt IE 9]>
      <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->

    <!-- Le fav and touch icons -->
    <link rel="apple-touch-icon-precomposed" sizes="144x144" href="assets/ico/apple-touch-icon-144-precomposed.png">
    <link rel="apple-touch-icon-precomposed" sizes="114x114" href="assets/ico/apple-touch-icon-114-precomposed.png">
Mark Otto's avatar
Mark Otto committed
23
24
      <link rel="apple-touch-icon-precomposed" sizes="72x72" href="assets/ico/apple-touch-icon-72-precomposed.png">
                    <link rel="apple-touch-icon-precomposed" href="assets/ico/apple-touch-icon-57-precomposed.png">
25
                                   <link rel="shortcut icon" href="assets/ico/favicon.png">
26
27
28

  </head>

29
  <body data-spy="scroll" data-target=".bs-docs-sidebar">
30
31
32

    <!-- Navbar
    ================================================== -->
33
    <div class="navbar navbar-inverse navbar-fixed-top">
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
      <div class="container">
        <button type="button" class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
          <span class="icon-bar"></span>
          <span class="icon-bar"></span>
          <span class="icon-bar"></span>
        </button>
        <a class="brand" href="./index.html">Bootstrap</a>
        <div class="nav-collapse collapse">
          <ul class="nav">
            <li class="">
              <a href="./index.html">Home</a>
            </li>
            <li class="active">
              <a href="./getting-started.html">Get started</a>
            </li>
            <li class="">
Mark Otto's avatar
Mark Otto committed
50
              <a href="./css.html">Core CSS</a>
51
52
53
54
55
56
57
58
59
60
            </li>
            <li class="">
              <a href="./components.html">Components</a>
            </li>
            <li class="">
              <a href="./javascript.html">JavaScript</a>
            </li>
            <li class="">
              <a href="./customize.html">Customize</a>
            </li>
61
62
63
            <li class="">
              <a href="./gallery.html">Gallery</a>
            </li>
64
          </ul>
65
66
67
68
        </div>
      </div>
    </div>

69
<!-- Subhead
70
================================================== -->
71
<header class="bs-docs-jumbotron subhead">
72
  <div class="container">
73
    <h1>Getting started</h1>
74
    <p class="lead">Overview of the project, its contents, and how to get started with a simple template.</p>
75
  </div>
76
77
</header>

78
79

  <div class="container">
80

81
82
83
84
    <!-- Docs nav
    ================================================== -->
    <div class="row">
      <div class="span3 bs-docs-sidebar">
Mark Otto's avatar
Mark Otto committed
85
        <ul class="nav nav-list bs-docs-sidenav">
Mark Otto's avatar
Mark Otto committed
86
87
88
89
90
91
          <li><a href="#download-bootstrap"><i class="glyphicon-chevron-right"></i> Download</a></li>
          <li><a href="#file-structure"><i class="glyphicon-chevron-right"></i> File structure</a></li>
          <li><a href="#contents"><i class="glyphicon-chevron-right"></i> What's included</a></li>
          <li><a href="#html-template"><i class="glyphicon-chevron-right"></i> HTML template</a></li>
          <li><a href="#examples"><i class="glyphicon-chevron-right"></i> Examples</a></li>
          <li><a href="#what-next"><i class="glyphicon-chevron-right"></i> What next?</a></li>
92
93
94
        </ul>
      </div>
      <div class="span9">
95
96
97



98
99
100
101
102
        <!-- Download
        ================================================== -->
        <section id="download-bootstrap">
          <div class="page-header">
            <h1>1. Download</h1>
103
          </div>
104
          <p class="lead">Before downloading, be sure to have a code editor (we recommend <a href="http://sublimetext.com/2">Sublime Text 2</a>) and some working knowledge of HTML and CSS. We won't walk through the source files here, but they are available for download. We'll focus on getting started with the compiled Bootstrap files.</p>
105

106
          <div class="row">
Mark Otto's avatar
Mark Otto committed
107
            <div class="span6">
Mark Otto's avatar
Mark Otto committed
108
              <h2>Download compiled</h2>
109
110
111
              <p><strong>Fastest way to get started:</strong> get the compiled and minified versions of our CSS, JS, and images. No docs or original source files.</p>
              <p><a class="btn btn-large btn-primary" href="assets/bootstrap.zip" >Download Bootstrap</a></p>
            </div>
Mark Otto's avatar
Mark Otto committed
112
            <div class="span6">
Mark Otto's avatar
Mark Otto committed
113
              <h2>Download source</h2>
Mark Otto's avatar
Mark Otto committed
114
              <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>
115
116
              <p><a class="btn btn-large" href="https://github.com/twitter/bootstrap/zipball/master" >Download Bootstrap source</a></p>
            </div>
117
          </div>
118
        </section>
119
120
121



122
123
124
125
126
127
        <!-- File structure
        ================================================== -->
        <section id="file-structure">
          <div class="page-header">
            <h1>2. File structure</h1>
          </div>
128
          <p class="lead">Within the download you'll find the following file structure and contents, logically grouping common assets and providing both compiled and minified variations.</p>
129
          <p>Once downloaded, unzip the compressed folder to see the structure of (the compiled) Bootstrap. You'll see something like this:</p>
Mark Otto's avatar
Mark Otto committed
130
131
132
133
134
135
136
137
138
139
140
<pre class="prettyprint">
  bootstrap/
  ├── css/
  │   ├── bootstrap.css
  │   ├── bootstrap.min.css
  ├── js/
  │   ├── bootstrap.js
  │   ├── bootstrap.min.js
  └── img/
      ├── glyphicons-halflings.png
      └── glyphicons-halflings-white.png
141
</pre>
142
          <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>
143
          <p>Please note that all JavaScript plugins require jQuery to be included.</p>
144
        </section>
145
146
147



148
149
150
151
152
153
        <!-- Contents
        ================================================== -->
        <section id="contents">
          <div class="page-header">
            <h1>3. What's included</h1>
          </div>
154
          <p class="lead">Bootstrap comes equipped with HTML, CSS, and JS for all sorts of things, but they can be summarized with a handful of categories visible at the top of the <a href="http://getbootstrap.com">Bootstrap documentation</a>.</p>
155

Mark Otto's avatar
Mark Otto committed
156
          <h2>Docs sections</h2>
157
158
159
160
161
162
          <h4><a href="http://twitter.github.com/bootstrap/scaffolding.html">Scaffolding</a></h4>
          <p>Global styles for the body to reset type and background, link styles, grid system, and two simple layouts.</p>
          <h4><a href="http://twitter.github.com/bootstrap/base-css.html">Base CSS</a></h4>
          <p>Styles for common HTML elements like typography, code, tables, forms, and buttons. Also includes <a href="http://glyphicons.com">Glyphicons</a>, a great little icon set.</p>
          <h4><a href="http://twitter.github.com/bootstrap/components.html">Components</a></h4>
          <p>Basic styles for common interface components like tabs and pills, navbar, alerts, page headers, and more.</p>
163
164
          <h4><a href="http://twitter.github.com/bootstrap/javascript.html">JavaScript plugins</a></h4>
          <p>Similar to Components, these JavaScript plugins are interactive components for things like tooltips, popovers, modals, and more.</p>
165

Mark Otto's avatar
Mark Otto committed
166
          <h2>List of components</h2>
167
          <p>Together, the <strong>Components</strong> and <strong>JavaScript plugins</strong> sections provide the following interface elements:</p>
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
          <ul>
            <li>Button groups</li>
            <li>Button dropdowns</li>
            <li>Navigational tabs, pills, and lists</li>
            <li>Navbar</li>
            <li>Labels</li>
            <li>Badges</li>
            <li>Page headers and hero unit</li>
            <li>Thumbnails</li>
            <li>Alerts</li>
            <li>Progress bars</li>
            <li>Modals</li>
            <li>Dropdowns</li>
            <li>Tooltips</li>
            <li>Popovers</li>
            <li>Accordion</li>
            <li>Carousel</li>
            <li>Typeahead</li>
          </ul>
          <p>In future guides, we may walk through these components individually in more detail. Until then, look for each of these in the documentation for information on how to utilize and customize them.</p>
        </section>



        <!-- HTML template
        ================================================== -->
        <section id="html-template">
          <div class="page-header">
            <h1>4. Basic HTML template</h1>
          </div>
Ramiro Morales's avatar
Ramiro Morales committed
198
          <p class="lead">With a brief intro into the contents out of the way, we can focus on putting Bootstrap to use. To do that, we'll utilize a basic HTML template that includes everything we mentioned in the <a href="#file-structure">File structure</a>.</p>
199
          <p>Now, here's a look at a <strong>typical HTML file</strong>:</p>
200
<pre class="prettyprint linenums">
201
&lt;!DOCTYPE html&gt;
202
203
204
205
206
207
&lt;html&gt;
  &lt;head&gt;
    &lt;title&gt;Bootstrap 101 Template&lt;/title&gt;
  &lt;/head&gt;
  &lt;body&gt;
    &lt;h1&gt;Hello, world!&lt;/h1&gt;
208
    &lt;script src="http://code.jquery.com/jquery-latest.js"&gt;&lt;/script&gt;
209
210
211
  &lt;/body&gt;
&lt;/html&gt;
</pre>
212
          <p>To make this <strong>a Bootstrapped template</strong>, just include the appropriate CSS and JS files:</p>
213
<pre class="prettyprint linenums">
214
&lt;!DOCTYPE html&gt;
215
216
217
218
&lt;html&gt;
  &lt;head&gt;
    &lt;title&gt;Bootstrap 101 Template&lt;/title&gt;
    &lt;!-- Bootstrap --&gt;
219
    &lt;link href="css/bootstrap.min.css" rel="stylesheet" media="screen"&gt;
220
221
222
  &lt;/head&gt;
  &lt;body&gt;
    &lt;h1&gt;Hello, world!&lt;/h1&gt;
223
    &lt;script src="http://code.jquery.com/jquery-latest.js"&gt;&lt;/script&gt;
224
    &lt;script src="js/bootstrap.min.js"&gt;&lt;/script&gt;
225
226
227
  &lt;/body&gt;
&lt;/html&gt;
</pre>
228
229
          <p><strong>And you're set!</strong> With those two files added, you can begin to develop any site or application with Bootstrap.</p>
        </section>
230

231
232


233
234
235
236
237
238
239
        <!-- Examples
        ================================================== -->
        <section id="examples">
          <div class="page-header">
            <h1>5. Examples</h1>
          </div>
          <p class="lead">Move beyond the base template with a few example layouts. 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
240
          <div class="row bootstrap-examples">
241
            <div class="span4">
242
243
244
245
246
              <a class="thumbnail" href="examples/starter-template.html">
                <img src="assets/img/examples/bootstrap-example-starter.jpg" alt="">
              </a>
              <h4>Starter template</h4>
              <p>A barebones HTML document with all the Bootstrap CSS and JavaScript included.</p>
247
            </div>
248
            <div class="span4">
249
250
251
              <a class="thumbnail" href="examples/hero.html">
                <img src="assets/img/examples/bootstrap-example-hero.jpg" alt="">
              </a>
252
              <h4>Basic marketing site</h4>
253
              <p>Featuring a hero unit for a primary message and three supporting elements.</p>
Mark Otto's avatar
Mark Otto committed
254
            </div>
255
            <div class="span4">
256
257
258
259
260
              <a class="thumbnail" href="examples/marketing-narrow.html">
                <img src="assets/img/examples/bootstrap-example-marketing-narrow.png" alt="">
              </a>
              <h4>Narrow marketing</h4>
              <p>Slim, lightweight marketing template for small projects or teams.</p>
Mark Otto's avatar
Mark Otto committed
261
            </div>
262
            <div class="span4">
263
264
265
266
267
              <a class="thumbnail" href="examples/signin.html">
                <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>
Mark Otto's avatar
Mark Otto committed
268
            </div>
269
            <div class="span4">
270
271
272
273
274
              <a class="thumbnail" href="examples/sticky-footer.html">
                <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>
275
276
            </div>
            <div class="span4">
277
278
279
280
281
              <a class="thumbnail" href="examples/carousel.html">
                <img src="assets/img/examples/bootstrap-example-carousel.png" alt="">
              </a>
              <h4>Carousel jumbotron</h4>
              <p>A more interactive riff on the basic marketing site featuring a prominent carousel.</p>
Mark Otto's avatar
Mark Otto committed
282
283
            </div>
          </div>
284
285
286
287
288
289
290
291
292
293
294
295
296
        </section>




        <!-- Next
        ================================================== -->
        <section id="what-next">
          <div class="page-header">
            <h1>What next?</h1>
          </div>
          <p class="lead">Head to the docs for information, examples, and code snippets, or take the next leap and customize Bootstrap for any upcoming project.</p>
          <a class="btn btn-large btn-primary" href="./scaffolding.html" >Visit the Bootstrap docs</a>
Mark Otto's avatar
Mark Otto committed
297
          <a class="btn btn-large" href="./customize.html" style="margin-left: 5px;" >Customize Bootstrap</a>
298
        </section>
299
300
301



302

303
      </div>
304
    </div>
305

306
  </div>
307

308

Mark Otto's avatar
Mark Otto committed
309

Mark Otto's avatar
Mark Otto committed
310
311
312
313
    <!-- Footer
    ================================================== -->
    <footer class="footer">
      <div class="container">
Mark Otto's avatar
Mark Otto committed
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332

        <div class="bs-docs-social">
          <ul class="bs-docs-social-buttons">
            <li>
              <iframe class="github-btn" src="http://ghbtns.com/github-btn.html?user=twitter&repo=bootstrap&type=watch&count=true" allowtransparency="true" frameborder="0" scrolling="0" width="100px" height="20px"></iframe>
            </li>
            <li>
              <iframe class="github-btn" src="http://ghbtns.com/github-btn.html?user=twitter&repo=bootstrap&type=fork&count=true" allowtransparency="true" frameborder="0" scrolling="0" width="102px" height="20px"></iframe>
            </li>
            <li class="follow-btn">
              <a href="https://twitter.com/twbootstrap" class="twitter-follow-button" data-link-color="#0069D6" data-show-count="true">Follow @twbootstrap</a>
            </li>
            <li class="tweet-btn">
              <a href="https://twitter.com/share" class="twitter-share-button" data-url="http://twitter.github.com/bootstrap/" data-count="horizontal" data-via="twbootstrap" data-related="mdo:Creator of Twitter Bootstrap">Tweet</a>
            </li>
          </ul>
        </div>


333
334
335
        <p>Designed and built with all the love in the world by <a href="http://twitter.com/mdo" target="_blank">@mdo</a> and <a href="http://twitter.com/fat" target="_blank">@fat</a>.</p>
        <p>Code licensed under <a href="http://www.apache.org/licenses/LICENSE-2.0" target="_blank">Apache License v2.0</a>, documentation under <a href="http://creativecommons.org/licenses/by/3.0/">CC BY 3.0</a>.</p>
        <p><a href="http://glyphicons.com">Glyphicons Free</a> licensed under <a href="http://creativecommons.org/licenses/by/3.0/">CC BY 3.0</a>.</p>
Mark Otto's avatar
Mark Otto committed
336
        <ul class="footer-links">
337
338
339
340
          <li><a href="http://blog.getbootstrap.com">Blog</a></li>
          <li class="muted">&middot;</li>
          <li><a href="https://github.com/twitter/bootstrap/issues?state=open">Issues</a></li>
          <li class="muted">&middot;</li>
Mark Otto's avatar
Mark Otto committed
341
342
343
344
          <li><a href="https://github.com/twitter/bootstrap/wiki">Roadmap and changelog</a></li>
        </ul>
      </div>
    </footer>
345

346

Mark Otto's avatar
Mark Otto committed
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365

    <!-- Le javascript
    ================================================== -->
    <!-- Placed at the end of the document so the pages load faster -->
    <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script>
    <script src="assets/js/jquery.js"></script>
    <script src="assets/js/bootstrap-transition.js"></script>
    <script src="assets/js/bootstrap-alert.js"></script>
    <script src="assets/js/bootstrap-modal.js"></script>
    <script src="assets/js/bootstrap-dropdown.js"></script>
    <script src="assets/js/bootstrap-scrollspy.js"></script>
    <script src="assets/js/bootstrap-tab.js"></script>
    <script src="assets/js/bootstrap-tooltip.js"></script>
    <script src="assets/js/bootstrap-popover.js"></script>
    <script src="assets/js/bootstrap-button.js"></script>
    <script src="assets/js/bootstrap-collapse.js"></script>
    <script src="assets/js/bootstrap-carousel.js"></script>
    <script src="assets/js/bootstrap-typeahead.js"></script>
    <script src="assets/js/bootstrap-affix.js"></script>
366
367
368
369

    <script src="assets/js/holder/holder.js"></script>
    <script src="assets/js/google-code-prettify/prettify.js"></script>

Mark Otto's avatar
Mark Otto committed
370
    <script src="assets/js/application.js"></script>
371
372
373
374
375



  </body>
</html>