contents.md 2.26 KB
Newer Older
1
2
3
---
layout: page
title: Contents
4
group: getting-started
5
6
---

7
Bootstrap can come in one of two forms, as precompiled or source code. Learn more about each form's contents and structure below.
8

9
10
11
12
13
{% callout warning %}
#### jQuery required

Please note that **all JavaScript plugins require jQuery** to be included, as shown in the [starter template](../quick-start). [Consult our `bower.json`]({{ site.repo }}/blob/v{{ site.current_version }}/bower.json) to see which versions of jQuery are supported.
{% endcallout %}
14

Mark Otto's avatar
Mark Otto committed
15
16
17
18
19
20
## Contents

* Will be replaced with the ToC, excluding the "Contents" header
{:toc}

## Precompiled Bootstrap
21
22
23
24
25
26
27
28
29

Once downloaded, unzip the compressed folder to see the structure of (the compiled) Bootstrap. You'll see something like this:

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

{% highlight bash %}
bootstrap/
├── css/
│   ├── bootstrap.css
Mark Otto's avatar
Mark Otto committed
30
│   ├── bootstrap.css.map
31
│   ├── bootstrap.min.css
Mark Otto's avatar
Mark Otto committed
32
│   └── bootstrap.min.css.map
33
34
35
36
37
└── js/
    ├── bootstrap.js
    └── bootstrap.min.js
{% endhighlight %}

Mark Otto's avatar
Mark Otto committed
38
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://developer.chrome.com/devtools/docs/css-preprocessors) (`bootstrap.*.map`) are available for use with certain browsers' developer tools.
39

Mark Otto's avatar
Mark Otto committed
40
## Bootstrap source code
41

Mark Otto's avatar
Mark Otto committed
42
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:
43
44
45
46
47
48

{% highlight bash %}
bootstrap/
├── dist/
│   ├── css/
│   └── js/
Mark Otto's avatar
Mark Otto committed
49
50
51
├── docs/
│   └── examples/
├── js/
Mark Otto's avatar
Mark Otto committed
52
└── scss/
53
54
{% endhighlight %}

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