contents.md 2.03 KB
Newer Older
1
---
Mark Otto's avatar
Mark Otto committed
2
layout: docs
3
title: Contents
Mark Otto's avatar
Mark Otto committed
4
description: Learn about what's included in Bootstrap's precompiled and source code directories.
5
group: getting-started
6
7
---

Mark Otto's avatar
Mark Otto committed
8
Bootstrap can come in one of two forms, as precompiled or source code. Learn more about each flavor's contents and structure below. Remember, no matter the implementation flavor, **Bootstrap's JavaScript plugins require jQuery**.
Mark Otto's avatar
Mark Otto committed
9
10

## Precompiled Bootstrap
11

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

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

16
{% highlight plaintext %}
17
18
19
bootstrap/
├── css/
│   ├── bootstrap.css
Mark Otto's avatar
Mark Otto committed
20
│   ├── bootstrap.css.map
21
│   ├── bootstrap.min.css
Mark Otto's avatar
Mark Otto committed
22
│   └── bootstrap.min.css.map
23
24
25
26
27
└── js/
    ├── bootstrap.js
    └── bootstrap.min.js
{% endhighlight %}

28
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.
29

Mark Otto's avatar
Mark Otto committed
30
## Bootstrap source code
31

Mark Otto's avatar
Mark Otto committed
32
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:
33

34
{% highlight plaintext %}
35
36
37
38
bootstrap/
├── dist/
│   ├── css/
│   └── js/
Mark Otto's avatar
Mark Otto committed
39
40
41
├── docs/
│   └── examples/
├── js/
Mark Otto's avatar
Mark Otto committed
42
└── scss/
43
44
{% endhighlight %}

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