introduction.md 7.08 KB
Newer Older
1
---
Mark Otto's avatar
Mark Otto committed
2
layout: docs
3
title: Introduction
4
description: Get started with Bootstrap, the world's most popular framework for building responsive, mobile-first sites, with BootstrapCDN and a template starter page.
5
group: getting-started
XhmikosR's avatar
XhmikosR committed
6
aliases:
Mark Otto's avatar
Mark Otto committed
7
  - "/docs/4.3/getting-started/"
XhmikosR's avatar
XhmikosR committed
8
9
  - "/docs/getting-started/"
  - "/getting-started/"
10
toc: true
11
12
13
14
---

## Quick start

XhmikosR's avatar
XhmikosR committed
15
Looking to quickly add Bootstrap to your project? Use BootstrapCDN, provided for free by the folks at StackPath. Using a package manager or need to download the source files? [Head to the downloads page](/docs/{{< param docs_version >}}/getting-started/download/).
16

17
18
### CSS

19
20
Copy-paste the stylesheet `<link>` into your `<head>` before all other stylesheets to load our CSS.

XhmikosR's avatar
XhmikosR committed
21
22
23
{{< highlight html >}}
<link rel="stylesheet" href="{{< param "cdn.css" >}}" integrity="{{< param "cdn.css_hash" >}}" crossorigin="anonymous">
{{< /highlight >}}
24

25
26
### JS

XhmikosR's avatar
XhmikosR committed
27
Many of our components require the use of JavaScript to function. Specifically, they require our own JavaScript plugins and [Popper.js](https://popper.js.org/). Place the following `<script>`s near the end of your pages, right before the closing `</body>` tag, to enable them. Popper.js must come first, and then our JavaScript plugins.
28

XhmikosR's avatar
XhmikosR committed
29
30
31
32
{{< highlight html >}}
<script src="{{< param "cdn.popper" >}}" integrity="{{< param "cdn.popper_hash" >}}" crossorigin="anonymous"></script>
<script src="{{< param "cdn.js" >}}" integrity="{{< param "cdn.js_hash" >}}" crossorigin="anonymous"></script>
{{< /highlight >}}
33

XhmikosR's avatar
XhmikosR committed
34
If you use `<script type="module">`, please refer to our [using Bootstrap as a module](/docs/{{< param docs_version >}}/getting-started/javascript/#using-bootstrap-as-a-module) section.
35

XhmikosR's avatar
XhmikosR committed
36
Curious which components explicitly require our JavaScript and Popper.js? Click the show components link below. If you're at all unsure about the general page structure, keep reading for an example page template.
37

XhmikosR's avatar
XhmikosR committed
38
Our `bootstrap.bundle.js` and `bootstrap.bundle.min.js` include [Popper](https://popper.js.org/). For more information about what's included in Bootstrap, please see our [contents](/docs/{{< param docs_version >}}/getting-started/contents/#precompiled-bootstrap) section.
39

40
41
<details>
<summary class="text-primary mb-3">Show components requiring JavaScript</summary>
XhmikosR's avatar
XhmikosR committed
42
{{< markdown >}}
43
44
45
46
47
48
49
50
51
- Alerts for dismissing
- Buttons for toggling states and checkbox/radio functionality
- Carousel for all slide behaviors, controls, and indicators
- Collapse for toggling visibility of content
- Dropdowns for displaying and positioning (also requires [Popper.js](https://popper.js.org/))
- Modals for displaying, positioning, and scroll behavior
- Navbar for extending our Collapse plugin to implement responsive behavior
- Tooltips and popovers for displaying and positioning (also requires [Popper.js](https://popper.js.org/))
- Scrollspy for scroll behavior and navigation updates
XhmikosR's avatar
XhmikosR committed
52
{{< /markdown >}}
53
</details>
54
55
56

## Starter template

57
Be sure to have your pages set up with the latest design and development standards. That means using an HTML5 doctype and including a viewport meta tag for proper responsive behaviors. Put it all together and your pages should look like this:
58

XhmikosR's avatar
XhmikosR committed
59
{{< highlight html >}}
60
<!doctype html>
61
62
<html lang="en">
  <head>
63
    <!-- Required meta tags -->
64
    <meta charset="utf-8">
65
    <meta name="viewport" content="width=device-width, initial-scale=1">
66
67

    <!-- Bootstrap CSS -->
XhmikosR's avatar
XhmikosR committed
68
    <link rel="stylesheet" href="{{< param "cdn.css" >}}" integrity="{{< param "cdn.css_hash" >}}" crossorigin="anonymous">
69
70

    <title>Hello, world!</title>
71
72
73
74
  </head>
  <body>
    <h1>Hello, world!</h1>

75
    <!-- Optional JavaScript -->
XhmikosR's avatar
XhmikosR committed
76
    <!-- Popper.js first, then Bootstrap JS -->
XhmikosR's avatar
XhmikosR committed
77
78
    <script src="{{< param "cdn.popper" >}}" integrity="{{< param "cdn.popper_hash" >}}" crossorigin="anonymous"></script>
    <script src="{{< param "cdn.js" >}}" integrity="{{< param "cdn.js_hash" >}}" crossorigin="anonymous"></script>
79
80
  </body>
</html>
XhmikosR's avatar
XhmikosR committed
81
{{< /highlight >}}
82

XhmikosR's avatar
XhmikosR committed
83
That's all you need for overall page requirements. Visit the [Layout docs](/docs/{{< param docs_version >}}/layout/overview/) or [our official examples](/docs/{{< param docs_version >}}/examples/) to start laying out your site's content and components.
Mark Otto's avatar
Mark Otto committed
84
85
86
87
88
89
90
91
92

## Important globals

Bootstrap employs a handful of important global styles and settings that you'll need to be aware of when using it, all of which are almost exclusively geared towards the *normalization* of cross browser styles. Let's dive in.

### HTML5 doctype

Bootstrap requires the use of the HTML5 doctype. Without it, you'll see some funky incomplete styling, but including it shouldn't cause any considerable hiccups.

XhmikosR's avatar
XhmikosR committed
93
{{< highlight html >}}
94
<!doctype html>
Mark Otto's avatar
Mark Otto committed
95
96
97
<html lang="en">
  ...
</html>
XhmikosR's avatar
XhmikosR committed
98
{{< /highlight >}}
Mark Otto's avatar
Mark Otto committed
99
100
101
102
103

### Responsive meta tag

Bootstrap is developed *mobile first*, a strategy in which we optimize code for mobile devices first and then scale up components as necessary using CSS media queries. To ensure proper rendering and touch zooming for all devices, **add the responsive viewport meta tag** to your `<head>`.

XhmikosR's avatar
XhmikosR committed
104
{{< highlight html >}}
105
<meta name="viewport" content="width=device-width, initial-scale=1">
XhmikosR's avatar
XhmikosR committed
106
{{< /highlight >}}
Mark Otto's avatar
Mark Otto committed
107

108
You can see an example of this in action in the [starter template](#starter-template).
Mark Otto's avatar
Mark Otto committed
109
110
111

### Box-sizing

112
For more straightforward sizing in CSS, we switch the global `box-sizing` value from `content-box` to `border-box`. This ensures `padding` does not affect the final computed width of an element, but it can cause problems with some third party software like Google Maps and Google Custom Search Engine.
Mark Otto's avatar
Mark Otto committed
113
114
115

On the rare occasion you need to override it, use something like the following:

XhmikosR's avatar
XhmikosR committed
116
{{< highlight css >}}
Mark Otto's avatar
Mark Otto committed
117
.selector-for-some-widget {
118
  box-sizing: content-box;
Mark Otto's avatar
Mark Otto committed
119
}
XhmikosR's avatar
XhmikosR committed
120
{{< /highlight >}}
Mark Otto's avatar
Mark Otto committed
121

122
With the above snippet, nested elements—including generated content via `::before` and `::after`—will all inherit the specified `box-sizing` for that `.selector-for-some-widget`.
Mark Otto's avatar
Mark Otto committed
123
124
125

Learn more about [box model and sizing at CSS Tricks](https://css-tricks.com/box-sizing/).

126
### Reboot
Mark Otto's avatar
Mark Otto committed
127

XhmikosR's avatar
XhmikosR committed
128
For improved cross-browser rendering, we use [Reboot](/docs/{{< param docs_version >}}/content/reboot/) to correct inconsistencies across browsers and devices while providing slightly more opinionated resets to common HTML elements.
129
130
131
132
133

## Community

Stay up to date on the development of Bootstrap and reach out to the community with these helpful resources.

XhmikosR's avatar
XhmikosR committed
134
135
136
- Follow [@getbootstrap on Twitter](https://twitter.com/{{< param twitter >}}).
- Read and subscribe to [The Official Bootstrap Blog]({{< param blog >}}/).
- Join [the official Slack room]({{< param slack >}}/).
137
- Chat with fellow Bootstrappers in IRC. On the `irc.freenode.net` server, in the `##bootstrap` channel.
138
- Implementation help may be found at Stack Overflow (tagged [`bootstrap-4`](https://stackoverflow.com/questions/tagged/bootstrap-4)).
XhmikosR's avatar
XhmikosR committed
139
- Developers should use the keyword `bootstrap` on packages which modify or add to the functionality of Bootstrap when distributing through [npm](https://www.npmjs.com/search?q=keywords:bootstrap) or similar delivery mechanisms for maximum discoverability.
140

XhmikosR's avatar
XhmikosR committed
141
You can also follow [@getbootstrap on Twitter](https://twitter.com/{{< param twitter >}}) for the latest gossip and awesome music videos.