git.roojs.org Git - bootswatch/blob - 2/bower_components/bootstrap/docs/getting-started.html

   1 <!DOCTYPE html>
   2 <html lang="en">
   3   <head>
   4     <meta charset="utf-8">
   5     <title>Getting · Bootstrap</title>
   6     <meta name="viewport" content="width=device-width, initial-scale=1.0">
   7     <meta name="description" content="">
   8     <meta name="author" content="">
   9
  10     <!-- Le styles -->
  11     <link href="assets/css/bootstrap.css" rel="stylesheet">
  12     <link href="assets/css/bootstrap-responsive.css" rel="stylesheet">
  13     <link href="assets/css/docs.css" rel="stylesheet">
  14     <link href="assets/js/google-code-prettify/prettify.css" rel="stylesheet">
  15
  16     <!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
  17     <!--[if lt IE 9]>
  18       <script src="assets/js/html5shiv.js"></script>
  19     <![endif]-->
  20
  21     <!-- Le fav and touch icons -->
  22     <link rel="apple-touch-icon-precomposed" sizes="144x144" href="assets/ico/apple-touch-icon-144-precomposed.png">
  23     <link rel="apple-touch-icon-precomposed" sizes="114x114" href="assets/ico/apple-touch-icon-114-precomposed.png">
  24       <link rel="apple-touch-icon-precomposed" sizes="72x72" href="assets/ico/apple-touch-icon-72-precomposed.png">
  25                     <link rel="apple-touch-icon-precomposed" href="assets/ico/apple-touch-icon-57-precomposed.png">
  26                                    <link rel="shortcut icon" href="assets/ico/favicon.png">
  27
  28     <script type="text/javascript">
  29       var _gaq = _gaq || [];
  30       _gaq.push(['_setAccount', 'UA-146052-10']);
  31       _gaq.push(['_trackPageview']);
  32       (function() {
  33         var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
  34         ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
  35         var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
  36       })();
  37     </script>
  38   </head>
  39
  40   <body data-spy="scroll" data-target=".bs-docs-sidebar">
  41
  42     <!-- Navbar
  43     ================================================== -->
  44     <div class="navbar navbar-inverse navbar-fixed-top">
  45       <div class="navbar-inner">
  46         <div class="container">
  47           <button type="button" class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
  48             <span class="icon-bar"></span>
  49             <span class="icon-bar"></span>
  50             <span class="icon-bar"></span>
  51           </button>
  52           <a class="brand" href="./index.html">Bootstrap</a>
  53           <div class="nav-collapse collapse">
  54             <ul class="nav">
  55               <li class="">
  56                 <a href="./index.html">Home</a>
  57               </li>
  58               <li class="active">
  59                 <a href="./getting-started.html">Get started</a>
  60               </li>
  61               <li class="">
  62                 <a href="./scaffolding.html">Scaffolding</a>
  63               </li>
  64               <li class="">
  65                 <a href="./base-css.html">Base CSS</a>
  66               </li>
  67               <li class="">
  68                 <a href="./components.html">Components</a>
  69               </li>
  70               <li class="">
  71                 <a href="./javascript.html">JavaScript</a>
  72               </li>
  73               <li class="">
  74                 <a href="./customize.html">Customize</a>
  75               </li>
  76             </ul>
  77           </div>
  78         </div>
  79       </div>
  80     </div>
  81
  82 <!-- Subhead
  83 ================================================== -->
  84 <header class="jumbotron subhead" id="overview">
  85   <div class="container">
  86     <h1>Getting started</h1>
  87     <p class="lead">Overview of the project, its contents, and how to get started with a simple template.</p>
  88   </div>
  89 </header>
  90
  91
  92   <div class="container">
  93
  94     <!-- Docs nav
  95     ================================================== -->
  96     <div class="row">
  97       <div class="span3 bs-docs-sidebar">
  98         <ul class="nav nav-list bs-docs-sidenav">
  99           <li><a href="#download-bootstrap"><i class="icon-chevron-right"></i> Download</a></li>
 100           <li><a href="#file-structure"><i class="icon-chevron-right"></i> File structure</a></li>
 101           <li><a href="#contents"><i class="icon-chevron-right"></i> What's included</a></li>
 102           <li><a href="#html-template"><i class="icon-chevron-right"></i> HTML template</a></li>
 103           <li><a href="#examples"><i class="icon-chevron-right"></i> Examples</a></li>
 104           <li><a href="#what-next"><i class="icon-chevron-right"></i> What next?</a></li>
 105         </ul>
 106       </div>
 107       <div class="span9">
 108
 109
 110
 111         <!-- Download
 112         ================================================== -->
 113         <section id="download-bootstrap">
 114           <div class="page-header">
 115             <h1>1. Download</h1>
 116           </div>
 117           <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>
 118
 119           <div class="row-fluid">
 120             <div class="span6">
 121               <h2>Download compiled</h2>
 122               <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>
 123               <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>
 124             </div>
 125             <div class="span6">
 126               <h2>Download source</h2>
 127               <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>
 128               <p><a class="btn btn-large" href="https://github.com/twbs/bootstrap/zipball/master" >Download Bootstrap source</a></p>
 129             </div>
 130           </div>
 131         </section>
 132
 133
 134
 135         <!-- File structure
 136         ================================================== -->
 137         <section id="file-structure">
 138           <div class="page-header">
 139             <h1>2. File structure</h1>
 140           </div>
 141           <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>
 142           <p>Once downloaded, unzip the compressed folder to see the structure of (the compiled) Bootstrap. You'll see something like this:</p>
 143 <pre class="prettyprint">
 144   bootstrap/
 145   ├── css/
 146   │   ├── bootstrap.css
 147   │   ├── bootstrap.min.css
 148   ├── js/
 149   │   ├── bootstrap.js
 150   │   ├── bootstrap.min.js
 151   └── img/
 152       ├── glyphicons-halflings.png
 153       └── glyphicons-halflings-white.png
 154 </pre>
 155           <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>
 156           <p>Please note that all JavaScript plugins require jQuery to be included.</p>
 157         </section>
 158
 159
 160
 161         <!-- Contents
 162         ================================================== -->
 163         <section id="contents">
 164           <div class="page-header">
 165             <h1>3. What's included</h1>
 166           </div>
 167           <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>
 168
 169           <h2>Docs sections</h2>
 170           <h4><a href="http://twbs.github.com/bootstrap/scaffolding.html">Scaffolding</a></h4>
 171           <p>Global styles for the body to reset type and background, link styles, grid system, and two simple layouts.</p>
 172           <h4><a href="http://twbs.github.com/bootstrap/base-css.html">Base CSS</a></h4>
 173           <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>
 174           <h4><a href="http://twbs.github.com/bootstrap/components.html">Components</a></h4>
 175           <p>Basic styles for common interface components like tabs and pills, navbar, alerts, page headers, and more.</p>
 176           <h4><a href="http://twbs.github.com/bootstrap/javascript.html">JavaScript plugins</a></h4>
 177           <p>Similar to Components, these JavaScript plugins are interactive components for things like tooltips, popovers, modals, and more.</p>
 178
 179           <h2>List of components</h2>
 180           <p>Together, the <strong>Components</strong> and <strong>JavaScript plugins</strong> sections provide the following interface elements:</p>
 181           <ul>
 182             <li>Button groups</li>
 183             <li>Button dropdowns</li>
 184             <li>Navigational tabs, pills, and lists</li>
 185             <li>Navbar</li>
 186             <li>Labels</li>
 187             <li>Badges</li>
 188             <li>Page headers and hero unit</li>
 189             <li>Thumbnails</li>
 190             <li>Alerts</li>
 191             <li>Progress bars</li>
 192             <li>Modals</li>
 193             <li>Dropdowns</li>
 194             <li>Tooltips</li>
 195             <li>Popovers</li>
 196             <li>Accordion</li>
 197             <li>Carousel</li>
 198             <li>Typeahead</li>
 199           </ul>
 200           <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>
 201         </section>
 202
 203
 204
 205         <!-- HTML template
 206         ================================================== -->
 207         <section id="html-template">
 208           <div class="page-header">
 209             <h1>4. Basic HTML template</h1>
 210           </div>
 211           <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="./getting-started.html#file-structure">File structure</a>.</p>
 212           <p>Now, here's a look at a <strong>typical HTML file</strong>:</p>
 213 <pre class="prettyprint linenums">
 214 &lt;!DOCTYPE html&gt;
 215 &lt;html&gt;
 216   &lt;head&gt;
 217     &lt;title&gt;Bootstrap 101 Template&lt;/title&gt;
 218     &lt;meta name="viewport" content="width=device-width, initial-scale=1.0"&gt;
 219   &lt;/head&gt;
 220   &lt;body&gt;
 221     &lt;h1&gt;Hello, world!&lt;/h1&gt;
 222     &lt;script src="http://code.jquery.com/jquery.js"&gt;&lt;/script&gt;
 223   &lt;/body&gt;
 224 &lt;/html&gt;
 225 </pre>
 226           <p>To make this <strong>a Bootstrapped template</strong>, just include the appropriate CSS and JS files:</p>
 227 <pre class="prettyprint linenums">
 228 &lt;!DOCTYPE html&gt;
 229 &lt;html&gt;
 230   &lt;head&gt;
 231     &lt;title&gt;Bootstrap 101 Template&lt;/title&gt;
 232     &lt;meta name="viewport" content="width=device-width, initial-scale=1.0"&gt;
 233     &lt;!-- Bootstrap --&gt;
 234     &lt;link href="css/bootstrap.min.css" rel="stylesheet" media="screen"&gt;
 235   &lt;/head&gt;
 236   &lt;body&gt;
 237     &lt;h1&gt;Hello, world!&lt;/h1&gt;
 238     &lt;script src="http://code.jquery.com/jquery.js"&gt;&lt;/script&gt;
 239     &lt;script src="js/bootstrap.min.js"&gt;&lt;/script&gt;
 240   &lt;/body&gt;
 241 &lt;/html&gt;
 242 </pre>
 243           <p><strong>And you're set!</strong> With those two files added, you can begin to develop any site or application with Bootstrap.</p>
 244         </section>
 245
 246
 247
 248         <!-- Examples
 249         ================================================== -->
 250         <section id="examples">
 251           <div class="page-header">
 252             <h1>5. Examples</h1>
 253           </div>
 254           <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>
 255           <ul class="thumbnails bootstrap-examples">
 256             <li class="span3">
 257               <a class="thumbnail" href="examples/starter-template.html">
 258                 <img src="assets/img/examples/bootstrap-example-starter.png" alt="">
 259               </a>
 260               <h4>Starter template</h4>
 261               <p>A barebones HTML document with all the Bootstrap CSS and JavaScript included.</p>
 262             </li>
 263             <li class="span3">
 264               <a class="thumbnail" href="examples/hero.html">
 265                 <img src="assets/img/examples/bootstrap-example-marketing.png" alt="">
 266               </a>
 267               <h4>Basic marketing site</h4>
 268               <p>Featuring a hero unit for a primary message and three supporting elements.</p>
 269             </li>
 270             <li class="span3">
 271               <a class="thumbnail" href="examples/fluid.html">
 272                 <img src="assets/img/examples/bootstrap-example-fluid.png" alt="">
 273               </a>
 274               <h4>Fluid layout</h4>
 275               <p>Uses our new responsive, fluid grid system to create a seamless liquid layout.</p>
 276             </li>
 277
 278             <li class="span3">
 279               <a class="thumbnail" href="examples/marketing-narrow.html">
 280                 <img src="assets/img/examples/bootstrap-example-marketing-narrow.png" alt="">
 281               </a>
 282               <h4>Narrow marketing</h4>
 283               <p>Slim, lightweight marketing template for small projects or teams.</p>
 284             </li>
 285             <li class="span3">
 286               <a class="thumbnail" href="examples/justified-nav.html">
 287                 <img src="assets/img/examples/bootstrap-example-justified-nav.png" alt="">
 288               </a>
 289               <h4>Justified nav</h4>
 290               <p>Marketing page with equal-width navigation links in a modified navbar.</p>
 291             </li>
 292             <li class="span3">
 293               <a class="thumbnail" href="examples/signin.html">
 294                 <img src="assets/img/examples/bootstrap-example-signin.png" alt="">
 295               </a>
 296               <h4>Sign in</h4>
 297               <p>Barebones sign in form with custom, larger form controls and a flexible layout.</p>
 298             </li>
 299
 300             <li class="span3">
 301               <a class="thumbnail" href="examples/sticky-footer.html">
 302                 <img src="assets/img/examples/bootstrap-example-sticky-footer.png" alt="">
 303               </a>
 304               <h4>Sticky footer</h4>
 305               <p>Pin a fixed-height footer to the bottom of the user's viewport.</p>
 306             </li>
 307             <li class="span3">
 308               <a class="thumbnail" href="examples/carousel.html">
 309                 <img src="assets/img/examples/bootstrap-example-carousel.png" alt="">
 310               </a>
 311               <h4>Carousel jumbotron</h4>
 312               <p>A more interactive riff on the basic marketing site featuring a prominent carousel.</p>
 313             </li>
 314           </ul>
 315         </section>
 316
 317
 318
 319
 320         <!-- Next
 321         ================================================== -->
 322         <section id="what-next">
 323           <div class="page-header">
 324             <h1>What next?</h1>
 325           </div>
 326           <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>
 327           <a class="btn btn-large btn-primary" href="./scaffolding.html" onclick="_gaq.push(['_trackEvent', 'Getting started', 'Next steps', 'Visit docs']);">Visit the Bootstrap docs</a>
 328           <a class="btn btn-large" href="./customize.html" style="margin-left: 5px;" onclick="_gaq.push(['_trackEvent', 'Getting started', 'Next steps', 'Customize']);">Customize Bootstrap</a>
 329         </section>
 330
 331
 332
 333
 334       </div>
 335     </div>
 336
 337   </div>
 338
 339
 340
 341     <!-- Footer
 342     ================================================== -->
 343     <footer class="footer">
 344       <div class="container">
 345         <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>
 346         <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>
 347         <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>
 348         <ul class="footer-links">
 349           <li><a href="http://blog.getbootstrap.com">Blog</a></li>
 350           <li class="muted">&middot;</li>
 351           <li><a href="https://github.com/twbs/bootstrap/issues?state=open">Issues</a></li>
 352           <li class="muted">&middot;</li>
 353           <li><a href="https://github.com/twbs/bootstrap/releases">Changelog</a></li>
 354         </ul>
 355       </div>
 356     </footer>
 357
 358
 359
 360     <!-- Le javascript
 361     ================================================== -->
 362     <!-- Placed at the end of the document so the pages load faster -->
 363     <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script>
 364     <script src="assets/js/jquery.js"></script>
 365     <script src="assets/js/bootstrap-transition.js"></script>
 366     <script src="assets/js/bootstrap-alert.js"></script>
 367     <script src="assets/js/bootstrap-modal.js"></script>
 368     <script src="assets/js/bootstrap-dropdown.js"></script>
 369     <script src="assets/js/bootstrap-scrollspy.js"></script>
 370     <script src="assets/js/bootstrap-tab.js"></script>
 371     <script src="assets/js/bootstrap-tooltip.js"></script>
 372     <script src="assets/js/bootstrap-popover.js"></script>
 373     <script src="assets/js/bootstrap-button.js"></script>
 374     <script src="assets/js/bootstrap-collapse.js"></script>
 375     <script src="assets/js/bootstrap-carousel.js"></script>
 376     <script src="assets/js/bootstrap-typeahead.js"></script>
 377     <script src="assets/js/bootstrap-affix.js"></script>
 378
 379     <script src="assets/js/holder/holder.js"></script>
 380     <script src="assets/js/google-code-prettify/prettify.js"></script>
 381
 382     <script src="assets/js/application.js"></script>
 383
 384
 385     <!-- Analytics
 386     ================================================== -->
 387     <script>
 388       var _gauges = _gauges || [];
 389       (function() {
 390         var t   = document.createElement('script');
 391         t.type  = 'text/javascript';
 392         t.async = true;
 393         t.id    = 'gauges-tracker';
 394         t.setAttribute('data-site-id', '4f0dc9fef5a1f55508000013');
 395         t.src = '//secure.gaug.es/track.js';
 396         var s = document.getElementsByTagName('script')[0];
 397         s.parentNode.insertBefore(t, s);
 398       })();
 399     </script>
 400
 401   </body>
 402 </html>