mirror of
https://github.com/twbs/bootstrap.git
synced 2024-12-10 22:24:19 +01:00
376 lines
21 KiB
HTML
376 lines
21 KiB
HTML
---
|
|
layout: default
|
|
title: Getting started
|
|
slug: getting-started
|
|
lead: "An overview of Bootstrap, how to download and use, basic templates and examples, and more."
|
|
base_url: "../"
|
|
---
|
|
|
|
|
|
<!-- Getting started
|
|
================================================== -->
|
|
<div class="bs-docs-section">
|
|
<div class="page-header">
|
|
<h1 id="download">Download Bootstrap</h1>
|
|
</div>
|
|
<p class="lead">There are a few easy ways to quickly get started with Bootstrap, each one appealing to a different skill level and use case. Read through to see what suits your particular needs.</p>
|
|
|
|
<h3>Download latest full source</h3>
|
|
<p>Until Bootstrap 3.0.0 is finalized, download the latest full source code (includes compiled and minified versions of our CSS and JavaScript under the <code>dist/</code> directory).</p>
|
|
<p><a class="btn btn-lg btn-primary" href="{{ site.download }}" onclick="_gaq.push(['_trackEvent', 'Getting started', 'Download', 'Download source']);">Download latest Bootstrap 3</a></p>
|
|
<!--
|
|
<h3>Download compiled CSS and JS</h3>
|
|
<p class="lead">The fastest way to get started is to get the compiled and minified versions of our CSS and JavaScript. No documentation or original source files are included.</p>
|
|
<p><a class="btn btn-lg btn-primary" href="{{ site.download_dist }}" onclick="_gaq.push(['_trackEvent', 'Getting started', 'Download', 'Download compiled']);">Download Bootstrap</a></p>
|
|
-->
|
|
|
|
<h3 id="download-options">More download options</h3>
|
|
<div class="bs-docs-dl-options">
|
|
<h4>
|
|
<a href="{{ site.download }}" onclick="_gaq.push(['_trackEvent', 'Getting started', 'Download', 'Download source']);">Download latest source code</a>
|
|
</h4>
|
|
<p>Get the original files for all CSS and JavaScript by downloading the latest version directly from GitHub.</p>
|
|
<h4>
|
|
<a href="{{ site.repo }}" onclick="_gaq.push(['_trackEvent', 'Getting started', 'Download', 'GitHub project']);">Clone or fork via GitHub</a>
|
|
</h4>
|
|
<p>Clone the entire project or fork your own version of Bootstrap to make it your own by visiting us on GitHub.</p>
|
|
<h4>
|
|
Install with <a href="http://bower.io">Bower</a>
|
|
</h4>
|
|
<p>Install and manage the original files for all CSS and JavaScript, along with a local copy of the docs, using <a href="http://bower.io">Bower</a>.</p>
|
|
{% highlight bash %}$ bower install bootstrap{% endhighlight %}
|
|
</div>
|
|
|
|
<h3 id="download-cdn">Use the Bootstrap CDN</h3>
|
|
<p>The folks over at <a href="https://www.netdna.com/">NetDNA</a> have graciously provided CDN support for Bootstrap's CSS and JavaScript. To use, swap your local instances for the <a href="http://www.bootstrapcdn.com/">Bootstrap CDN</a> links listed below.</p>
|
|
{% highlight html linenos %}
|
|
<!-- Latest compiled and minified CSS -->
|
|
<link rel="stylesheet" href="{{ site.cdn_css }}">
|
|
|
|
<!-- Latest compiled and minified JavaScript -->
|
|
<script src="{{ site.cdn_js }}"></script>
|
|
{% endhighlight %}
|
|
|
|
<div class="bs-callout bs-callout-warning" id="callout-less-compilation">
|
|
<h4>LESS compilation</h4>
|
|
<p>If you download the original files, you need to compile Bootstrap's LESS files into usable CSS. To do that, Bootstrap only officially supports <a href="http://twitter.github.io/recess/">Recess</a>, Twitter's CSS hinter built on top of <a href="http://lesscss.org">less.js</a>.</p>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<!-- File structure
|
|
================================================== -->
|
|
<div class="bs-docs-section">
|
|
<div class="page-header">
|
|
<h1 id="whats-included">What's included</h1>
|
|
</div>
|
|
<p class="lead">Within the download you'll find the following directories and files, logically grouping common assets and providing both compiled and minified variations.</p>
|
|
<p>Once downloaded, unzip the compressed folder to see the structure of (the compiled) Bootstrap. You'll see something like this:</p>
|
|
|
|
{% highlight bash %}
|
|
bootstrap/
|
|
├── css/
|
|
│ ├── bootstrap.css
|
|
│ ├── bootstrap.min.css
|
|
├── js/
|
|
│ ├── bootstrap.js
|
|
│ ├── bootstrap.min.js
|
|
{% endhighlight %}
|
|
|
|
<p>This is the most basic form of Bootstrap: compiled files for quick drop-in usage in nearly any web project. We provide compiled CSS and JS (<code>bootstrap.*</code>), as well as compiled and minified CSS and JS (<code>bootstrap.min.*</code>).</p>
|
|
<div class="bs-callout bs-callout-danger">
|
|
<h4>jQuery required</h4>
|
|
<p>Please note that <strong>all JavaScript plugins require jQuery</strong> to be included, as shown in the <a href="#template">starter template</a>.</p>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<!-- Template
|
|
================================================== -->
|
|
<div class="bs-docs-section">
|
|
<div class="page-header">
|
|
<h1 id="template">Basic template</h1>
|
|
</div>
|
|
<p class="lead">Make use of a super basic HTML template, or dive into a <a href="{{ site.examples }}">few examples</a> we've started for you. We encourage folks to iterate on these examples and not simply use them as an end result.</p>
|
|
|
|
<p>Copy and paste the HTML from below to get started with a bare bones Bootstrap document.</p>
|
|
{% highlight html %}
|
|
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<title>Bootstrap 101 Template</title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<!-- Bootstrap -->
|
|
<link href="css/bootstrap.min.css" rel="stylesheet" media="screen">
|
|
</head>
|
|
<body>
|
|
<h1>Hello, world!</h1>
|
|
|
|
<!-- jQuery (necessary for Bootstrap's JavaScript plugins) -->
|
|
<script src="//code.jquery.com/jquery.js"></script>
|
|
<!-- Include all compiled plugins (below), or include individual files as needed -->
|
|
<script src="js/bootstrap.min.js"></script>
|
|
|
|
<!-- Enable responsive features in IE8 with Respond.js (https://github.com/scottjehl/Respond) -->
|
|
<script src="js/respond.js"></script>
|
|
</body>
|
|
</html>
|
|
{% endhighlight %}
|
|
|
|
<h3>Looking for more example templates?</h3>
|
|
<p>Check out the new <a href="{{ site.examples_repo }}">Examples repository on GitHub</a>, or <a href="{{ site.examples }}">view them in your browser</a>. Included are over a dozen example templates for building with and extending Bootstrap.</p>
|
|
</div>
|
|
|
|
|
|
|
|
<!-- Browser support
|
|
================================================== -->
|
|
<div class="bs-docs-section">
|
|
<div class="page-header">
|
|
<h1 id="browsers">Browser support</h1>
|
|
</div>
|
|
<p class="lead">Bootstrap is built to work best in the latest desktop and mobile browsers, meaning older and less advanced browsers might receive a less stylized, though fully functional, version of certain components.</p>
|
|
|
|
<h3>Supported browsers</h3>
|
|
<p>Specifically, we support the latest versions of the following:</p>
|
|
<ul>
|
|
<li>Chrome (Mac, Windows, iOS, and Android)</li>
|
|
<li>Safari (Mac and iOS only, as Windows has more or less been discontinued)</li>
|
|
<li>Firefox (Mac, Windows)</li>
|
|
<li>Internet Explorer</li>
|
|
<li>Opera (Mac, Windows)</li>
|
|
</ul>
|
|
<p>Unofficially, Bootstrap should look and behave well enough in Chromium for Linux and Internet Explorer 7, though they are not officially supported.</p>
|
|
|
|
<h3>Internet Explorer 8 and 9</h3>
|
|
<p>Internet Explorer 8 and 9 are also supported, however, please be aware that many CSS3 properties—e.g., rounded corners and shadows—are not supported by IE8. The <code>placeholder</code> attribute is also not supported in either of these versions.</p>
|
|
<p>In addition, <strong>Internet Explorer 8 requires the use of <a href="https://github.com/scottjehl/Respond">respond.js</a> to enable media query support.</strong></p>
|
|
|
|
<h3>IE Compatibility modes</h3>
|
|
<p>Bootstrap is not supported in the old Internet Explorer compatibility modes. To be sure you're using the latest rendering mode for IE, consider including the appropriate <code>meta</code> tag in your pages:</p>
|
|
{% highlight html %}
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
{% endhighlight %}
|
|
<p>See <a href="http://stackoverflow.com/questions/6771258/whats-the-difference-if-meta-http-equiv-x-ua-compatible-content-ie-edge">this StackOverflow question</a> for more information.</p>
|
|
|
|
<h3>Windows Phone 8 and Internet Explorer 10</h3>
|
|
<p>Internet Explorer 10 doesn't differentiate device width from viewport width, and thus doesn't properly apply the media queries in Bootstrap's CSS. To address this, you can optionally include the following CSS and JavaScript to work around this problem until Microsoft issues a fix.</p>
|
|
{% highlight css %}
|
|
@-webkit-viewport { width: device-width; }
|
|
@-moz-viewport { width: device-width; }
|
|
@-ms-viewport { width: device-width; }
|
|
@-o-viewport { width: device-width; }
|
|
@viewport { width: device-width; }
|
|
{% endhighlight %}
|
|
|
|
{% highlight js %}
|
|
if (navigator.userAgent.match(/IEMobile\/10\.0/)) {
|
|
var msViewportStyle = document.createElement("style");
|
|
msViewportStyle.appendChild(
|
|
document.createTextNode(
|
|
"@-ms-viewport{width:auto!important}"
|
|
)
|
|
);
|
|
document.getElementsByTagName("head")[0].appendChild(msViewportStyle);
|
|
}
|
|
{% endhighlight %}
|
|
<p>For more information and usage guidelines, read <a href="http://timkadlec.com/2013/01/windows-phone-8-and-device-width/">Windows Phone 8 and Device-Width</a>.</p>
|
|
|
|
<h3>Safari percent rounding</h3>
|
|
<p>In the latest Safari for Mac, its rendering engine has a little trouble with the long decimal places of our <code>.col-*-1</code> grid classes, meaning if you have 12 individual columns you'll notice they come up short compared to other rows of columns. There's not much we can do here (<a href="https://github.com/twbs/bootstrap/issues/9282">see #9282</a>) but you do have some options:</p>
|
|
<ul>
|
|
<li>Add <code>.pull-right</code> to your last grid column to get the hard-right alignment</li>
|
|
<li>Tweak your percentages manually to get the perfect rounding for Safari (more difficult than the first option)</li>
|
|
</ul>
|
|
<p>We'll keep an eye on this though and update our code if we have an easy solution.</p>
|
|
|
|
<h3>Modals and mobile devices</h3>
|
|
<p>Support for <code>overflow: hidden</code> on the <code><body></code> element is quite limited in iOS and Android. To that end, when you scroll past the top or bottom of a modal in either of those devices' browsers, the <code><body></code> content will begin to scroll.</p>
|
|
</div>
|
|
|
|
|
|
|
|
<!-- Third party support
|
|
================================================== -->
|
|
<div class="bs-docs-section">
|
|
<div class="page-header">
|
|
<h1 id="third-parties">Third party support</h1>
|
|
</div>
|
|
<p class="lead">While we don't officially support any third party plugins or add-ons, we do offer some useful advice to help avoid potential issues in your projects.</p>
|
|
|
|
<h3>Google Maps</h3>
|
|
<p>If you're using Google Maps on a Bootstrapped project, you might run into some display problems due to our use of <code>* { box-sizing: border-box; }</code>. Previously, you may have also ran into issues with the use of <code>max-width</code> on images. The following snippet should avoid all those problems.</p>
|
|
{% highlight css %}
|
|
/* Fix Google Maps canvas
|
|
*
|
|
* Wrap your Google Maps embed in a `.google-map-canvas` to reset Bootstrap's
|
|
* global `box-sizing` changes. You may optionally need to reset the `max-width`
|
|
* on images in case you've applied that anywhere else. (That shouldn't be as
|
|
* necessary with Bootstrap 3 though as that behavior is relegated to the
|
|
* `.img-responsive` class.)
|
|
*/
|
|
|
|
.google-map-canvas,
|
|
.google-map-canvas * { .box-sizing(content-box); }
|
|
|
|
/* Optional responsive image override */
|
|
img { max-width: none; }
|
|
{% endhighlight %}
|
|
</div>
|
|
|
|
|
|
|
|
<!-- Accessibility
|
|
================================================== -->
|
|
<div class="bs-docs-section">
|
|
<div class="page-header">
|
|
<h1 id="accessibility">Accessibility</h1>
|
|
</div>
|
|
<p class="lead">Bootstrap follows common web standards, and with minimal extra effort, can be used to create sites that are accessibile to those using <abbr title="Assistive Technology" class="initialism">AT</abbr>.</p>
|
|
|
|
<h3>Skip navigation</h3>
|
|
<p>If your navigation contains many links and comes before the main content in the DOM, add a <code>Skip to content</code> link immediately after your opening <code><body></code> tag. <a href="http://a11yproject.com/posts/skip-nav-links/">(read why)</a></p>
|
|
{% highlight html %}
|
|
<body>
|
|
<a href="#content" class="sr-only">Skip to content</a>
|
|
<div class="container" id="content">
|
|
The main page content.
|
|
</div>
|
|
</body>
|
|
{% endhighlight %}
|
|
|
|
<h3>Nested headers</h3>
|
|
<p>Another "gotcha" has to do with how you nest your <code><header></code> elements. <a href="http://squizlabs.github.io/HTML_CodeSniffer/Standards/Section508/">Section 508</a> states that your largest header must be an <code>h1</code>, and the next header must be an <code><h2></code>, etc. This is hard to achieve in practice, but if the largest header on your site is smaller than Bootstrap's default 38px, you should consider modifying your stylesheets before using a smaller header element.</p>
|
|
|
|
<h3>Additional resources</h3>
|
|
<ul>
|
|
<li><a href="https://github.com/squizlabs/HTML_CodeSniffer">"HTML Codesniffer" bookmarklet for identifying accessibility issues</a></li>
|
|
<li><a href="http://a11yproject.com/">The A11Y Project</a></li>
|
|
<li><a href="https://developer.mozilla.org/en-US/docs/Accessibility">MDN accessibility documentation</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
<!-- License FAQs
|
|
================================================== -->
|
|
<div class="bs-docs-section">
|
|
<div class="page-header">
|
|
<h1 id="license-faqs">License FAQs</h1>
|
|
</div>
|
|
<p class="lead">Bootstrap is released under the Apache 2 license and is copyright {{ site.time | date: "%Y" }} Twitter. Boiled down to smaller chunks, it can be described with the following conditions.</p>
|
|
|
|
<div class="row">
|
|
<div class="col-12 col-lg-6">
|
|
<h4>It allows you to:</h4>
|
|
<ul>
|
|
<li>Freely download and use Bootstrap, in whole or in part, for personal, company internal or commercial purposes</li>
|
|
<li>Use Bootstrap in packages or distributions that you create</li>
|
|
</ul>
|
|
</div>
|
|
<div class="col-12 col-lg-6">
|
|
<h4>It forbids you to:</h4>
|
|
<ul>
|
|
<li>Redistribute any piece of Bootstrap without proper attribution</li>
|
|
<li>Use any marks owned by Twitter in any way that might state or imply that Twitter endorses your distribution</li>
|
|
<li>Use any marks owned by Twitter in any way that might state or imply that you created the Twitter software in question</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="row">
|
|
<div class="col-12 col-lg-6">
|
|
<h4>It requires you to:</h4>
|
|
<ul>
|
|
<li>Include a copy of the license in any redistribution you may make that includes Bootstrap</li>
|
|
<li>Provide clear attribution to Twitter for any distributions that include Bootstrap</li>
|
|
</ul>
|
|
</div>
|
|
<div class="col-12 col-lg-6">
|
|
<h4>It does not require you to:</h4>
|
|
<ul>
|
|
<li>Include the source of Bootstrap itself, or of any modifications you may have made to it, in any redistribution you may assemble that includes it</li>
|
|
<li>Submit changes that you make to Bootstrap back to the Bootstrap project (though such feedback is encouraged)</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<p>The full Bootstrap license is located <a href="{{ site.repo }}/blob/master/README.md">in the project repository</a> for more information.</p>
|
|
</div><!-- /.bs-docs-section -->
|
|
|
|
|
|
|
|
|
|
<div class="bs-docs-section">
|
|
<div class="page-header">
|
|
<h1 id="customizing">Customizing Bootstrap</h1>
|
|
</div>
|
|
<p class="lead">Customizing Bootstrap is best accomplished when you treat it as another dependency in your development stack. Doing so ensures future upgrades are as easy as possible while also familiarizing yourself to the intricacies of the framework.</p>
|
|
|
|
<p>Once you've downloaded and included Bootstrap's CSS into your templates, you can move on to customizing the included components. To do so, create a new stylesheet (LESS, if you like, or just plain CSS) to house your customizations.</p>
|
|
|
|
<div class="bs-callout bs-callout-info">
|
|
<h4>Compiled or minified?</h4>
|
|
<p>Unless you plan on reading a good chunk of the compiled CSS, go with the minified. It's the same code, just compacted. Less bandwidth is good, especially in production environments.</p>
|
|
</div>
|
|
|
|
<p>From there, include whatever Bootstrap components and HTML content you need to get your template setup. It's best to have a rough idea in mind of modifications to make and content to include, so be sure to spend a brief amount of time on that before moving on.</p>
|
|
|
|
<h3>Customizing components</h3>
|
|
<p>There are varying degrees to customizing components, but most fall into two camps: light customizations and complete visual overhauls. Luckily, there are plenty of examples of both.</p>
|
|
<p>We define light customizations as mostly surface layer changes, things like a color and font changes to existing Bootstrap components. A great example of this is the the <a href="http://translate.twitter.com">Twitter Translation Center</a> (coded by @mdo). Let's look at how to implement the custom button we wrote for this site, <code>.btn-ttc</code>.</p>
|
|
<p>Instead of using the provided Bootstrap buttons, which only require just one class to start, <code>.btn</code>, we'll add our own modifier class, <code>.btn-ttc</code>. This will give us a slightly custom look with minimal effort.</p>
|
|
{% highlight html %}
|
|
<button type="button" class="btn btn-ttc">Save changes</button>
|
|
{% endhighlight %}
|
|
|
|
<p>In the custom stylesheet, add the following CSS:</p>
|
|
|
|
{% highlight css %}
|
|
/* Custom button
|
|
-------------------------------------------------- */
|
|
|
|
/* Override base .btn styles */
|
|
/* Apply text and background changes to three key states: default, hover, and active (click). */
|
|
.btn-ttc,
|
|
.btn-ttc:hover,
|
|
.btn-ttc:active {
|
|
color: white;
|
|
text-shadow: 0 -1px 0 rgba(0, 0, 0, 0.25);
|
|
background-color: #007da7;
|
|
}
|
|
|
|
/* Apply the custom-colored gradients */
|
|
/* Note: you'll need to include all the appropriate gradients for various browsers and standards. */
|
|
.btn-ttc {
|
|
background-repeat: repeat-x;
|
|
background-image: linear-gradient(top, #009ED2 0%, #007DA7 100%);
|
|
...
|
|
}
|
|
|
|
/* Set the hover state */
|
|
/* An easy hover state is just to move the gradient up a small amount. Add other embellishments as you see fit. */
|
|
.btn-ttc:hover {
|
|
background-position: 0 -15px;
|
|
}
|
|
{% endhighlight %}
|
|
|
|
<p>Customizing Bootstrap components takes time, but should be straightforward. <strong>Look to the source code often and duplicate the selectors you need for your modifications.</strong> Placing them after the Bootstrap source makes for easy overriding without complication. <strong>To recap, here's the basic workflow:</strong></p>
|
|
<ul>
|
|
<li>For each element you want to customize, find its code in the compiled Bootstrap CSS. Copy and paste the selector for a component as-is. For instance, to customize the navbar background, just snag <code>.navbar</code>.</li>
|
|
<li>Add all your custom CSS in a separate stylesheet using the selectors you just copied from the Bootstrap source. No need for prefacing with additional classes or using <code>!important</code> here.</li>
|
|
<li>Rinse and repeat until you're happy with your customizations.</li>
|
|
</ul>
|
|
<p>Going beyond light customizations and into visual overhauls is just as straightforward as the above custom button. For a site like <a href="http://yourkarma.com">Karma</a>, which uses Bootstrap as a CSS reset with heavy modifications, more extensive work is involved, but well worth it in the end.</p>
|
|
|
|
<div class="bs-callout bs-callout-info">
|
|
<h4>Alternate customization methods</h4>
|
|
<p>While not recommended for folks new to Bootstrap, you may use one of two alternate methods for customization. The first is modifying the source .less files (making upgrades super difficult), and the second is mapping source LESS code to <a href="http://ruby.bvision.com/blog/please-stop-embedding-bootstrap-classes-in-your-html">your own classes via mixins</a>. For the time being, neither options are documented here.</p>
|
|
</div>
|
|
|
|
<h3>Removing potential bloat</h3>
|
|
<p>Not all sites and applications need to make use of everything Bootstrap has to offer, especially in production environments where bandwidth literally becomes a financial issue. We encourage folks to remove whatever is unused with our <a href="../customize/">Customizer</a>.</p>
|
|
<p>Using the Customizer, simply uncheck any component, feature, or asset you don't need. Hit download and swap out the default Bootstrap files with these newly customized ones. You'll get vanilla Bootstrap, but without the features *you* deem unnecessary. All custom builds include compiled and minified versions, so use whichever works for you.</p>
|
|
|
|
</div>
|