contents.md 5.47 KB
Newer Older
1
---
Mark Otto's avatar
Mark Otto committed
2
layout: docs
3
title: Contents
4
description: Discover what's included in Bootstrap, including our precompiled and source code flavors. Remember, Bootstrap's JavaScript plugins require jQuery.
5
group: getting-started
6
toc: true
7
8
---

Mark Otto's avatar
Mark Otto committed
9
## Precompiled Bootstrap
10

Mark Otto's avatar
Mark Otto committed
11
Once downloaded, unzip the compressed folder and you'll see something like this:
12

Martijn Cuppens's avatar
Martijn Cuppens committed
13
<!-- NOTE: This info is intentionally duplicated in the README. Copy any changes made here over to the README too, but be sure to keep in mind to add the `dist` folder. -->
14

15
{% highlight plaintext %}
16
17
bootstrap/
├── css/
18
19
20
21
22
23
24
│   ├── bootstrap-grid.css
│   ├── bootstrap-grid.css.map
│   ├── bootstrap-grid.min.css
│   ├── bootstrap-grid.min.css.map
│   ├── bootstrap-reboot.css
│   ├── bootstrap-reboot.css.map
│   ├── bootstrap-reboot.min.css
Martijn Cuppens's avatar
Martijn Cuppens committed
25
26
27
28
29
│   ├── bootstrap-reboot.min.css.map
│   ├── bootstrap.css
│   ├── bootstrap.css.map
│   ├── bootstrap.min.css
│   └── bootstrap.min.css.map
30
└── js/
31
    ├── bootstrap.bundle.js
Martijn Cuppens's avatar
Martijn Cuppens committed
32
    ├── bootstrap.bundle.js.map
33
    ├── bootstrap.bundle.min.js
Martijn Cuppens's avatar
Martijn Cuppens committed
34
    ├── bootstrap.bundle.min.js.map
35
    ├── bootstrap.js
Martijn Cuppens's avatar
Martijn Cuppens committed
36
37
38
    ├── bootstrap.js.map
    ├── bootstrap.min.js
    └── bootstrap.min.js.map
39
40
{% endhighlight %}

Johann-S's avatar
Johann-S committed
41
This is the most basic form of Bootstrap: precompiled files for quick drop-in usage in nearly any web project. We provide compiled CSS and JS (`bootstrap.*`), as well as compiled and minified CSS and JS (`bootstrap.min.*`). [source maps](https://developers.google.com/web/tools/chrome-devtools/javascript/source-maps) (`bootstrap.*.map`) are available for use with certain browsers' developer tools. Bundled JS files (`bootstrap.bundle.js` and minified `bootstrap.bundle.min.js`) include [Popper](https://popper.js.org/), but not [jQuery](https://jquery.com/).
42

43
44
45
## CSS files

Bootstrap includes a handful of options for including some or all of our compiled CSS.
46

Mark Otto's avatar
Mark Otto committed
47
<table class="table table-bordered">
48
49
50
  <thead>
    <tr>
      <th scope="col">CSS files</th>
51
52
53
54
      <th scope="col">Layout</th>
      <th scope="col">Content</th>
      <th scope="col">Components</th>
      <th scope="col">Utilities</th>
55
56
57
58
59
    </tr>
  </thead>
  <tbody>
    <tr>
      <th scope="row">
60
61
        <div><code class="font-weight-normal text-nowrap">bootstrap.css</code></div>
        <div><code class="font-weight-normal text-nowrap">bootstrap.min.css</code></div>
62
      </th>
63
64
65
66
      <td class="text-success">Included</td>
      <td class="text-success">Included</td>
      <td class="text-success">Included</td>
      <td class="text-success">Included</td>
67
68
69
    </tr>
    <tr>
      <th scope="row">
70
71
        <div><code class="font-weight-normal text-nowrap">bootstrap-grid.css</code></div>
        <div><code class="font-weight-normal text-nowrap">bootstrap-grid.min.css</code></div>
72
      </th>
73
74
75
76
      <td><a class="text-warning" href="{{ site.baseurl }}/docs/{{ site.docs_version }}/layout/grid/">Only grid system</a></td>
      <td class="bg-light text-muted">Not included</td>
      <td class="bg-light text-muted">Not included</td>
      <td><a class="text-warning" href="{{ site.baseurl }}/docs/{{ site.docs_version }}/utilities/flex/">Only flex utilities</a></td>
77
78
79
    </tr>
    <tr>
      <th scope="row">
80
81
        <div><code class="font-weight-normal text-nowrap">bootstrap-reboot.css</code></div>
        <div><code class="font-weight-normal text-nowrap">bootstrap-reboot.min.css</code></div>
82
      </th>
83
84
85
86
      <td class="bg-light text-muted">Not included</td>
      <td><a class="text-warning" href="{{ site.baseurl }}/docs/{{ site.docs_version }}/content/reboot/">Only Reboot</a></td>
      <td class="bg-light text-muted">Not included</td>
      <td class="bg-light text-muted">Not included</td>
87
88
89
90
    </tr>
  </tbody>
</table>

91
92
93
## JS files

Similarly, we have options for including some or all of our compiled JavaScript.
94

Mark Otto's avatar
Mark Otto committed
95
<table class="table table-bordered">
96
97
98
  <thead>
    <tr>
      <th scope="col">JS files</th>
99
100
      <th scope="col">Popper</th>
      <th scope="col">jQuery</th>
101
102
103
104
105
    </tr>
  </thead>
  <tbody>
    <tr>
      <th scope="row">
106
107
        <div><code class="font-weight-normal text-nowrap">bootstrap.bundle.js</code></div>
        <div><code class="font-weight-normal text-nowrap">bootstrap.bundle.min.js</code></div>
108
      </th>
109
110
      <td class="text-success">Included</td>
      <td class="bg-light text-muted">Not included</td>
111
112
113
    </tr>
    <tr>
      <th scope="row">
114
115
        <div><code class="font-weight-normal text-nowrap">bootstrap.js</code></div>
        <div><code class="font-weight-normal text-nowrap">bootstrap.min.js</code></div>
116
      </th>
117
118
      <td class="bg-light text-muted">Not included</td>
      <td class="bg-light text-muted">Not included</td>
119
120
121
122
    </tr>
  </tbody>
</table>

Mark Otto's avatar
Mark Otto committed
123
## Bootstrap source code
124

Mark Otto's avatar
Mark Otto committed
125
The Bootstrap source code download includes the precompiled CSS and JavaScript assets, along with source Sass, JavaScript, and documentation. More specifically, it includes the following and more:
126

127
{% highlight plaintext %}
128
129
130
131
bootstrap/
├── dist/
│   ├── css/
│   └── js/
Mark Otto's avatar
Mark Otto committed
132
133
134
├── docs/
│   └── examples/
├── js/
Mark Otto's avatar
Mark Otto committed
135
└── scss/
136
137
{% endhighlight %}

Mark Otto's avatar
Mark Otto committed
138
The `scss/` and `js/` are the source code for our CSS and JavaScript. The `dist/` folder includes everything listed in the precompiled download section above. The `docs/` folder includes the source code for our documentation, and `examples/` of Bootstrap usage. Beyond that, any other included file provides support for packages, license information, and development.