mirror of
https://github.com/twbs/bootstrap.git
synced 2024-11-30 12:24:19 +01:00
aaf03bdc9e
* Initial spike of consolidated form checks * Stub out forms rearrangement - Prepping to drop non-custom file and range inputs - Prepping to merge custom and native checks and radios (with switches) - Prepping to merge custom select with form select - Moving docs arround so forms has it's own area given volume of CSS * Move input group Sass file to forms subdir * Start to split and move the docs around * Simpler imports * Copyediting * delete overview file * Remove commented out code * remove the custom-forms import * rewrite flex-check as form-check, replace all custom properties * Remove old forms doc * stub out new subpage link section * update migration guide * Update nav, forms overview in page nav, and descriptions * fix check bg position * fix margin-top calculation * rename .custom-select to .form-select * Update validation styles for new checks * add some vertical margin, fix inline checks * fix docs examples * better way to do this contents stuff, redo the toc while i'm at it * page restyle for docs while here * un-callout that, edit text * redo padding on toc * fix toc * start to cleanup checks docs * Rewrite Markdown tables into HTML * Redesign tables, redo their docs * Replace Open Iconic icons with custom Bootstrap icons * Redesign the docs navbar, add a subheader, redo the sidebar * Redesign docs homepage a bit * Simplify table style overrides for docs tables * Simplify docs typography for page titles and reading line length * Stub out icons page * Part of sidebar update, remove migration from nav.yml * Move toc CSS to separate partial * Change appearance of overview page * fix sidebar arrow direction * Add footer to docs layout * Update descriptions * Drop the .form-group class for margin utilities * Remove lingering form-group-margin-bottom var * improve footer spacing * add headings to range page * uncomment form range css * Rename .custom-range to .form-range * Drop unused docs var * Uncomment the comment * Remove unused variable * Fix radio image sizing * Reboot update: reset horizontal ul and ol padding * de-dupe IDs * tweak toc styles * nvm, fix dropdown versions stuff * remove sidebar nav toggle for now * broken html * fix more broken html, move css * scss linting * comment out broken helper docs * scope styles * scope styles * Fixes #25540 and fixes #26407 for v5 only * Update sidebar once more * Match new sidenav order * fix syntax error * Rename custom-file to form-file, update paths, update migration docs for previous changes in #28696 * rename back * fix size and alignment * rename that back too
143 lines
5.2 KiB
Markdown
143 lines
5.2 KiB
Markdown
---
|
|
layout: docs
|
|
title: Contents
|
|
description: Discover what's included in Bootstrap, including our precompiled and source code flavors.
|
|
group: getting-started
|
|
toc: true
|
|
---
|
|
|
|
## Precompiled Bootstrap
|
|
|
|
Once downloaded, unzip the compressed folder and 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, but be sure to keep in mind to add the `dist` folder. -->
|
|
|
|
{{< highlight text >}}
|
|
bootstrap/
|
|
├── css/
|
|
│ ├── 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
|
|
│ ├── bootstrap.css
|
|
│ ├── bootstrap.css.map
|
|
│ ├── bootstrap.min.css
|
|
│ └── bootstrap.min.css.map
|
|
└── js/
|
|
├── bootstrap.bundle.js
|
|
├── bootstrap.bundle.js.map
|
|
├── bootstrap.bundle.min.js
|
|
├── bootstrap.bundle.min.js.map
|
|
├── bootstrap.esm.js
|
|
├── bootstrap.esm.js.map
|
|
├── bootstrap.esm.min.js
|
|
├── bootstrap.esm.min.js.map
|
|
├── bootstrap.js
|
|
├── bootstrap.js.map
|
|
├── bootstrap.min.js
|
|
└── bootstrap.min.js.map
|
|
{{< /highlight >}}
|
|
|
|
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/).
|
|
|
|
## CSS files
|
|
|
|
Bootstrap includes a handful of options for including some or all of our compiled CSS.
|
|
|
|
<table class="table">
|
|
<thead>
|
|
<tr>
|
|
<th scope="col">CSS files</th>
|
|
<th scope="col">Layout</th>
|
|
<th scope="col">Content</th>
|
|
<th scope="col">Components</th>
|
|
<th scope="col">Utilities</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<th scope="row">
|
|
<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>
|
|
</th>
|
|
<td>Included</td>
|
|
<td>Included</td>
|
|
<td>Included</td>
|
|
<td>Included</td>
|
|
</tr>
|
|
<tr>
|
|
<th scope="row">
|
|
<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>
|
|
</th>
|
|
<td><a class="text-muted" href="{{< docsref "/layout/grid" >}}">Only grid system</a></td>
|
|
<td class="text-muted">—</td>
|
|
<td class="text-muted">—</td>
|
|
<td><a class="text-muted" href="{{< docsref "/utilities/flex" >}}">Only flex utilities</a></td>
|
|
</tr>
|
|
<tr>
|
|
<th scope="row">
|
|
<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>
|
|
</th>
|
|
<td class="text-muted">—</td>
|
|
<td><a class="text-muted" href="{{< docsref "/content/reboot" >}}">Only Reboot</a></td>
|
|
<td class="text-muted">—</td>
|
|
<td class="text-muted">—</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
## JS files
|
|
|
|
Similarly, we have options for including some or all of our compiled JavaScript.
|
|
|
|
<table class="table">
|
|
<thead>
|
|
<tr>
|
|
<th scope="col">JS files</th>
|
|
<th scope="col">Popper</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<th scope="row">
|
|
<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>
|
|
</th>
|
|
<td>Included</td>
|
|
</tr>
|
|
<tr>
|
|
<th scope="row">
|
|
<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>
|
|
</th>
|
|
<td class="text-muted">—</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
## Bootstrap source code
|
|
|
|
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:
|
|
|
|
{{< highlight text >}}
|
|
bootstrap/
|
|
├── dist/
|
|
│ ├── css/
|
|
│ └── js/
|
|
├── site/
|
|
│ └──content/
|
|
│ └── docs/
|
|
│ └── 4.3/
|
|
│ └── examples/
|
|
├── js/
|
|
└── scss/
|
|
{{< /highlight >}}
|
|
|
|
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.
|