contents.md 5.71 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
│   ├── bootstrap-reboot.min.css.map
julian-hecker's avatar
julian-hecker committed
26
27
28
29
│   ├── bootstrap-utilities.css
│   ├── bootstrap-utilities.css.map
│   ├── bootstrap-utilities.min.css
│   ├── bootstrap-utilities.min.css.map
Martijn Cuppens's avatar
Martijn Cuppens committed
30
31
32
33
│   ├── bootstrap.css
│   ├── bootstrap.css.map
│   ├── bootstrap.min.css
│   └── bootstrap.min.css.map
34
└── js/
35
    ├── bootstrap.bundle.js
Martijn Cuppens's avatar
Martijn Cuppens committed
36
    ├── bootstrap.bundle.js.map
37
    ├── bootstrap.bundle.min.js
Martijn Cuppens's avatar
Martijn Cuppens committed
38
    ├── bootstrap.bundle.min.js.map
39
40
41
42
    ├── bootstrap.esm.js
    ├── bootstrap.esm.js.map
    ├── bootstrap.esm.min.js
    ├── bootstrap.esm.min.js.map
43
    ├── bootstrap.js
Martijn Cuppens's avatar
Martijn Cuppens committed
44
45
46
    ├── bootstrap.js.map
    ├── bootstrap.min.js
    └── bootstrap.min.js.map
XhmikosR's avatar
XhmikosR committed
47
{{< /highlight >}}
48

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

51
52
53
## CSS files

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

Mark Otto's avatar
Mark Otto committed
55
<table class="table">
56
57
58
  <thead>
    <tr>
      <th scope="col">CSS files</th>
59
60
61
62
      <th scope="col">Layout</th>
      <th scope="col">Content</th>
      <th scope="col">Components</th>
      <th scope="col">Utilities</th>
63
64
65
66
67
    </tr>
  </thead>
  <tbody>
    <tr>
      <th scope="row">
68
69
        <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>
70
      </th>
Mark Otto's avatar
Mark Otto committed
71
72
73
74
      <td>Included</td>
      <td>Included</td>
      <td>Included</td>
      <td>Included</td>
75
76
77
    </tr>
    <tr>
      <th scope="row">
78
79
        <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>
80
      </th>
Mark Otto's avatar
Mark Otto committed
81
82
83
84
      <td><a class="text-muted" href="{{< docsref "/layout/grid" >}}">Only grid system</a></td>
      <td class="text-muted">&mdash;</td>
      <td class="text-muted">&mdash;</td>
      <td><a class="text-muted" href="{{< docsref "/utilities/flex" >}}">Only flex utilities</a></td>
85
    </tr>
86
87
88
89
90
91
92
93
94
95
    <tr>
      <th scope="row">
        <div><code class="font-weight-normal text-nowrap">bootstrap-utilities.css</code></div>
        <div><code class="font-weight-normal text-nowrap">bootstrap-utilities.min.css</code></div>
      </th>
      <td class="text-muted">&mdash;</td>
      <td class="text-muted">&mdash;</td>
      <td class="text-muted">&mdash;</td>
      <td>Included</td>
    </tr>
96
97
    <tr>
      <th scope="row">
98
99
        <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>
100
      </th>
Mark Otto's avatar
Mark Otto committed
101
102
103
104
      <td class="text-muted">&mdash;</td>
      <td><a class="text-muted" href="{{< docsref "/content/reboot" >}}">Only Reboot</a></td>
      <td class="text-muted">&mdash;</td>
      <td class="text-muted">&mdash;</td>
105
106
107
108
    </tr>
  </tbody>
</table>

109
110
111
## JS files

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

Mark Otto's avatar
Mark Otto committed
113
<table class="table">
114
115
116
  <thead>
    <tr>
      <th scope="col">JS files</th>
117
      <th scope="col">Popper</th>
118
119
120
121
122
    </tr>
  </thead>
  <tbody>
    <tr>
      <th scope="row">
123
124
        <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>
125
      </th>
Mark Otto's avatar
Mark Otto committed
126
      <td>Included</td>
127
128
129
    </tr>
    <tr>
      <th scope="row">
130
131
        <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>
132
      </th>
Mark Otto's avatar
Mark Otto committed
133
      <td class="text-muted">&mdash;</td>
134
135
136
137
    </tr>
  </tbody>
</table>

Mark Otto's avatar
Mark Otto committed
138
## Bootstrap source code
139

Mark Otto's avatar
Mark Otto committed
140
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:
141

XhmikosR's avatar
XhmikosR committed
142
{{< highlight text >}}
143
144
145
146
bootstrap/
├── dist/
│   ├── css/
│   └── js/
XhmikosR's avatar
XhmikosR committed
147
├── site/
XhmikosR's avatar
XhmikosR committed
148
149
150
151
│   └──content/
│      └── docs/
│          └── 4.3/
│              └── examples/
Mark Otto's avatar
Mark Otto committed
152
├── js/
Mark Otto's avatar
Mark Otto committed
153
└── scss/
XhmikosR's avatar
XhmikosR committed
154
{{< /highlight >}}
155

XhmikosR's avatar
XhmikosR committed
156
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.