contents.md 5.41 KB
Newer Older
1
---
Mark Otto's avatar
Mark Otto committed
2
layout: docs
3
title: Contents
XhmikosR's avatar
XhmikosR committed
4
description: Discover what's included in Bootstrap, including our precompiled and source code flavors.
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

XhmikosR's avatar
XhmikosR committed
15
{{< highlight text >}}
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
36
37
38
    ├── bootstrap.esm.js
    ├── bootstrap.esm.js.map
    ├── bootstrap.esm.min.js
    ├── bootstrap.esm.min.js.map
39
    ├── bootstrap.js
Martijn Cuppens's avatar
Martijn Cuppens committed
40
41
42
    ├── bootstrap.js.map
    ├── bootstrap.min.js
    └── bootstrap.min.js.map
XhmikosR's avatar
XhmikosR committed
43
{{< /highlight >}}
44

XhmikosR's avatar
XhmikosR committed
45
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/).
46

47
48
49
## CSS files

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

Mark Otto's avatar
Mark Otto committed
51
<table class="table table-bordered">
52
53
54
  <thead>
    <tr>
      <th scope="col">CSS files</th>
55
56
57
58
      <th scope="col">Layout</th>
      <th scope="col">Content</th>
      <th scope="col">Components</th>
      <th scope="col">Utilities</th>
59
60
61
62
63
    </tr>
  </thead>
  <tbody>
    <tr>
      <th scope="row">
64
65
        <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>
66
      </th>
67
68
69
70
      <td class="text-success">Included</td>
      <td class="text-success">Included</td>
      <td class="text-success">Included</td>
      <td class="text-success">Included</td>
71
72
73
    </tr>
    <tr>
      <th scope="row">
74
75
        <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>
76
      </th>
XhmikosR's avatar
XhmikosR committed
77
      <td><a class="text-warning" href="/docs/{{< param docs_version >}}/layout/grid/">Only grid system</a></td>
78
79
      <td class="bg-light text-muted">Not included</td>
      <td class="bg-light text-muted">Not included</td>
XhmikosR's avatar
XhmikosR committed
80
      <td><a class="text-warning" href="/docs/{{< param docs_version >}}/utilities/flex/">Only flex utilities</a></td>
81
82
83
    </tr>
    <tr>
      <th scope="row">
84
85
        <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>
86
      </th>
87
      <td class="bg-light text-muted">Not included</td>
XhmikosR's avatar
XhmikosR committed
88
      <td><a class="text-warning" href="/docs/{{< param docs_version >}}/content/reboot/">Only Reboot</a></td>
89
90
      <td class="bg-light text-muted">Not included</td>
      <td class="bg-light text-muted">Not included</td>
91
92
93
94
    </tr>
  </tbody>
</table>

95
96
97
## JS files

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

Mark Otto's avatar
Mark Otto committed
99
<table class="table table-bordered">
100
101
102
  <thead>
    <tr>
      <th scope="col">JS files</th>
103
      <th scope="col">Popper</th>
104
105
106
107
108
    </tr>
  </thead>
  <tbody>
    <tr>
      <th scope="row">
109
110
        <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>
111
      </th>
112
      <td class="text-success">Included</td>
113
114
115
    </tr>
    <tr>
      <th scope="row">
116
117
        <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>
118
      </th>
119
      <td class="bg-light text-muted">Not included</td>
120
121
122
123
    </tr>
  </tbody>
</table>

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

Mark Otto's avatar
Mark Otto committed
126
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:
127

XhmikosR's avatar
XhmikosR committed
128
{{< highlight text >}}
129
130
131
132
bootstrap/
├── dist/
│   ├── css/
│   └── js/
XhmikosR's avatar
XhmikosR committed
133
├── site/
XhmikosR's avatar
XhmikosR committed
134
135
136
137
│   └──content/
│      └── docs/
│          └── 4.3/
│              └── examples/
Mark Otto's avatar
Mark Otto committed
138
├── js/
Mark Otto's avatar
Mark Otto committed
139
└── scss/
XhmikosR's avatar
XhmikosR committed
140
{{< /highlight >}}
141

XhmikosR's avatar
XhmikosR committed
142
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 `site/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.