getting-started.html 12.3 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <title>Getting · Twitter Bootstrap</title>
    <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/bootstrap-responsive.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="shortcut icon" href="assets/ico/favicon.ico">
    <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">
    <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">

  </head>

  <body data-spy="scroll" data-target=".bs-docs-sidebar" data-offset="10">

    <!-- Navbar
    ================================================== -->
    <div class="navbar navbar-fixed-top">
      <div class="navbar-inner">
        <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>
48
49
50
              <li class="active">
                <a href="./getting-started.html">Get started</a>
              </li>
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
              <li class="">
                <a href="./scaffolding.html">Scaffolding</a>
              </li>
              <li class="">
                <a href="./base-css.html">Base CSS</a>
              </li>
              <li class="">
                <a href="./components.html">Components</a>
              </li>
              <li class="">
                <a href="./javascript.html">Javascript</a>
              </li>
              <li class="">
                <a href="./extend.html">Extend</a>
              </li>
            </ul>
          </div>
        </div>
      </div>
    </div>

72
<!-- Subhead
73
74
================================================== -->
<header class="jumbotron subhead" id="overview">
75
  <div class="container">
76
77
78
    <h1>Getting started</h1>
    <p class="lead">Overview of the project, it's contents, and how to get started with a simple template.</p>
  </div>
79
80
</header>

81
<div class="container">
82
83


84
85
86
87
88
89
90
  <div class="row">
    <div class="span3 bs-docs-sidebar">
      <ul class="nav nav-list bs-docs-sidenav">
        <li><a href="#download-bootstrap">Download <i class="icon-chevron-right"></i></a></li>
        <li><a href="#file-structure">File structure <i class="icon-chevron-right"></i></a></li>
        <li><a href="#contents">What's included <i class="icon-chevron-right"></i></a></li>
        <li><a href="#html-template">HTML template <i class="icon-chevron-right"></i></a></li>
91
      </ul>
92
93
    </div>
    <div class="span9">
94
95
96



97
98
99
100
101
102
103
      <!-- Download
      ================================================== -->
      <section id="download-bootstrap">
        <div class="page-header">
          <h1>1. Download</h1>
        </div>
        <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 our the compiled Bootstrap files.</p>
104

105
106
107
108
        <div class="row">
          <div class="span4">
            <h3>Download compiled</h3>
            <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>
109
            <p><a class="btn btn-large btn-primary" href="assets/bootstrap.zip" >Download Bootstrap</a></p>
110
111
112
113
          </div>
          <div class="span4">
            <h3>Download source</h3>
            <p>Get the original files for all CSS and Javasript, along with a local copy of the docs by downloading the latest version directly from GitHub.</p>
114
            <p><a class="btn btn-large" href="https://github.com/twitter/bootstrap/zipball/master" >Download Bootstrap source</a></p>
115
116
117
          </div>
        </div>
      </section>
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
190
191
192
193
194
195
196
197
198
199
200
201
      <!-- File structure
      ================================================== -->
      <section id="file-structure">
        <div class="page-header">
          <h1>2. File structure</h1>
        </div>
        <p>Once downloaded, unzip the compressed folder to see the structure of (the compiled) Bootstrap. You'll see something like this:</p>
<pre class="prettyprint">
  bootstrap/
  ├── css/
  │   ├── bootstrap.css
  │   ├── bootstrap.min.css
  ├── js/
  │   ├── bootstrap.js
  │   ├── bootstrap.min.js
  ├── img/
  │   ├── glyphicons-halflings.png
  │   ├── glyphicons-halflings-white.png
  └── README.md
</pre>
        <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>
      </section>



      <!-- Contents
      ================================================== -->
      <section id="contents">
        <div class="page-header">
          <h1>3. What's included</h1>
        </div>
        <p>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>

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

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

        <hr>

        <h3>List of components</h3>
        <p>Together, the <strong>Components</strong> and <strong>Javascript plugins</strong> sections provide the following interface elements:</p>
        <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>
        <p>With a brief intro into the contents out of the way, we can focus 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>
        <p>Now, here's a look at a <strong>typical HTML file</strong>:</p>
202
203
204
205
206
207
208
209
210
211
<pre class="prettyprint linenums">
&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;
  &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
214
215
216
217
218
219
220
221
<pre class="prettyprint linenums">
&lt;html&gt;
  &lt;head&gt;
    &lt;title&gt;Bootstrap 101 Template&lt;/title&gt;
    &lt;!-- Bootstrap --&gt;
    &lt;link href="css/bootstrap.min.css" rel="stylesheet"&gt;
  &lt;/head&gt;
  &lt;body&gt;
    &lt;h1&gt;Hello, world!&lt;/h1&gt;
222
    &lt;script src="js/bootstrap.min.js"&gt;&lt;/script&gt;
223
224
225
  &lt;/body&gt;
&lt;/html&gt;
</pre>
226
227
228
229
230
231
        <p><strong>And you're set!</strong> With those two files added, you can begin to develop any site or application with Bootstrap.</p>

        <hr>

        <h2>What next?</h2>
        <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>
232
233
        <a class="btn btn-large" href="./scaffolding.html" >Visit the Bootstrap docs</a>
        <a class="btn btn-large" href="./download.html" style="margin-left: 5px;" >Customize Bootstrap</a>
234
      </section>
235
236
237



238
    </div>
239
  </div>
240

241
242
</div>

Mark Otto's avatar
Mark Otto committed
243

244

Mark Otto's avatar
Mark Otto committed
245
246
247
248
   <!-- Footer
    ================================================== -->
    <footer class="footer">
      <div class="container">
249
250
251
252
253
254
255
256
257
        <p class="pull-right"><a href="#">Back to top</a></p>
        <p>Designed and built with all the love in the world <a href="http://twitter.com/twitter" target="_blank">@twitter</a> 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 the <a href="http://www.apache.org/licenses/LICENSE-2.0" target="_blank">Apache License v2.0</a>. Documentation licensed under <a href="http://creativecommons.org/licenses/by/3.0/">CC BY 3.0</a>.</p>
        <p>Icons from <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>
        <ul class="footer-links">
          <li><a href="http://blog.getbootstrap.com">Read the blog</a></li>
          <li><a href="https://github.com/twitter/bootstrap/issues?state=open">Submit issues</a></li>
          <li><a href="https://github.com/twitter/bootstrap/wiki">Roadmap and changelog</a></li>
        </ul>
Mark Otto's avatar
Mark Otto committed
258
259
      </div>
    </footer>
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285



    <!-- 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/google-code-prettify/prettify.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/application.js"></script>


  </body>
</html>