contents.md 5.38 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
13
14

<!-- NOTE: This info is intentionally duplicated in the README. Copy any changes made here over to the README too. -->

15
{% highlight plaintext %}
16
17
18
bootstrap/
├── css/
│   ├── bootstrap.css
Mark Otto's avatar
Mark Otto committed
19
│   ├── bootstrap.css.map
20
│   ├── bootstrap.min.css
21
22
23
24
25
26
27
28
29
│   ├── bootstrap.min.css.map
│   ├── 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
│   └── bootstrap-reboot.min.css.map
30
└── js/
31
32
    ├── bootstrap.bundle.js
    ├── bootstrap.bundle.min.js
33
34
35
36
    ├── bootstrap.js
    └── bootstrap.min.js
{% endhighlight %}

37
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.*`). CSS [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/).
38

39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
### Comparison of CSS files

<table class="table table-bordered table-responsive">
  <thead>
    <tr>
      <th scope="col">CSS files</th>
      <th scope="col" class="text-center">Layout</th>
      <th scope="col" class="text-center">Content</th>
      <th scope="col" class="text-center">Components</th>
      <th scope="col" class="text-center">Utilities</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <th scope="row">
        <div><code class="text-nowrap">bootstrap.css</code></div>
        <div><code class="text-nowrap">bootstrap.min.css</code></div>
      </th>
      <td class="table-success text-center align-middle">All</td>
      <td class="table-success text-center align-middle">All</td>
      <td class="table-success text-center align-middle">All</td>
      <td class="table-success text-center align-middle">All</td>
    </tr>
    <tr>
      <th scope="row">
        <div><code class="text-nowrap">bootstrap-grid.css</code></div>
        <div><code class="text-nowrap">bootstrap-grid.min.css</code></div>
      </th>
      <td class="table-warning text-center align-middle">Only <a href="{{ site.baseurl }}/docs/{{ site.docs_version }}/layout/grid/">grid</a> system</td>
      <td class="table-danger text-center align-middle">No</td>
      <td class="table-danger text-center align-middle">No</td>
      <td class="table-warning text-center align-middle">Only <a href="{{ site.baseurl }}/docs/{{ site.docs_version }}/utilities/flex/">flex</a> utilities</td>
    </tr>
    <tr>
      <th scope="row">
        <div><code class="text-nowrap">bootstrap-reboot.css</code></div>
        <div><code class="text-nowrap">bootstrap-reboot.min.css</code></div>
      </th>
      <td class="table-danger text-center align-middle">No</td>
      <td class="table-warning text-center align-middle">Only <a href="{{ site.baseurl }}/docs/{{ site.docs_version }}/content/reboot/">Reboot</a></td>
      <td class="table-danger text-center align-middle">No</td>
      <td class="table-danger text-center align-middle">No</td>
    </tr>
  </tbody>
</table>

85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
### Comparison of JS files

<table class="table table-bordered table-responsive">
  <thead>
    <tr>
      <th scope="col">JS files</th>
      <th scope="col" class="text-center">Popper</th>
      <th scope="col" class="text-center">jQuery</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <th scope="row">
        <div><code class="text-nowrap">bootstrap.bundle.js</code></div>
        <div><code class="text-nowrap">bootstrap.bundle.min.js</code></div>
      </th>
      <td class="table-success text-center align-middle">Included</td>
      <td class="table-danger text-center align-middle">Not included</td>
    </tr>
    <tr>
      <th scope="row">
        <div><code class="text-nowrap">bootstrap.js</code></div>
        <div><code class="text-nowrap">bootstrap.min.js</code></div>
      </th>
      <td class="table-danger text-center align-middle">Not included</td>
      <td class="table-danger text-center align-middle">Not included</td>
    </tr>
  </tbody>
</table>

Mark Otto's avatar
Mark Otto committed
115
## Bootstrap source code
116

Mark Otto's avatar
Mark Otto committed
117
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:
118

119
{% highlight plaintext %}
120
121
122
123
bootstrap/
├── dist/
│   ├── css/
│   └── js/
Mark Otto's avatar
Mark Otto committed
124
125
126
├── docs/
│   └── examples/
├── js/
Mark Otto's avatar
Mark Otto committed
127
└── scss/
128
129
{% endhighlight %}

Mark Otto's avatar
Mark Otto committed
130
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.