]> git.ipfire.org Git - ipfire.org.git/blame - src/scss/bootstrap-4.0.0-alpha.6/docs/getting-started/contents.md
Introduce autotools
[ipfire.org.git] / src / scss / bootstrap-4.0.0-alpha.6 / docs / getting-started / contents.md
CommitLineData
91e44d91
S
1---
2layout: docs
3title: Contents
4description: Learn about what's included in Bootstrap's precompiled and source code directories.
5group: getting-started
6---
7
8Bootstrap 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**.
9
10## Precompiled Bootstrap
11
12Once downloaded, unzip the compressed folder and you'll see something like this:
13
14<!-- NOTE: This info is intentionally duplicated in the README. Copy any changes made here over to the README too. -->
15
16{% highlight plaintext %}
17bootstrap/
18├── css/
19│ ├── bootstrap.css
20│ ├── bootstrap.css.map
21│ ├── bootstrap.min.css
22│ └── bootstrap.min.css.map
23└── js/
24 ├── bootstrap.js
25 └── bootstrap.min.js
26{% endhighlight %}
27
28This 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
30## Bootstrap source code
31
32The 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 %}
35bootstrap/
36├── dist/
37│ ├── css/
38│ └── js/
39├── docs/
40│ └── examples/
41├── js/
42└── scss/
43{% endhighlight %}
44
45The `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.