mirror of
https://github.com/twbs/bootstrap.git
synced 2025-08-13 17:14:04 +02:00
Drop contents and best practices docs pages
This commit is contained in:
Mark Otto
@@ -7,7 +7,6 @@
|
||||
pages:
|
||||
- title: Introduction
|
||||
- title: Download
|
||||
- title: Contents
|
||||
- title: Browsers & devices
|
||||
- title: JavaScript
|
||||
- title: Webpack
|
||||
|
||||
@@ -1,18 +0,0 @@
|
||||
---
|
||||
title: Best practices
|
||||
description: Learn about some of the best practices we’ve gathered from years of working on and using Bootstrap.
|
||||
---
|
||||
|
||||
We’ve designed and developed Bootstrap to work in a number of environments. Here are some of the best practices we’ve gathered from years of working on and using it ourselves.
|
||||
|
||||
<Callout>
|
||||
**Heads up!** This copy is a work in progress.
|
||||
</Callout>
|
||||
|
||||
### General outline
|
||||
|
||||
- Working with CSS
|
||||
- Working with Sass files
|
||||
- Building new CSS components
|
||||
- Working with flexbox
|
||||
- Ask in [our GitHub Discussions](https://github.com/twbs/bootstrap/discussions)
|
||||
@@ -1,111 +0,0 @@
|
||||
---
|
||||
title: Contents
|
||||
description: Discover what’s included in Bootstrap, including our compiled and source code flavors.
|
||||
toc: true
|
||||
|
||||
# TODO: possible to replace the tree by something like https://docs.astro.build/en/guides/content-collections/#what-are-content-collections?
|
||||
---
|
||||
|
||||
## Compiled 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. */}
|
||||
|
||||
```text
|
||||
bootstrap/
|
||||
├── css/
|
||||
│ ├── bootstrap-grid.css
|
||||
│ ├── bootstrap-grid.css.map
|
||||
│ ├── bootstrap-grid.min.css
|
||||
│ ├── bootstrap-grid.min.css.map
|
||||
│ ├── bootstrap-grid.rtl.css
|
||||
│ ├── bootstrap-grid.rtl.css.map
|
||||
│ ├── bootstrap-grid.rtl.min.css
|
||||
│ ├── bootstrap-grid.rtl.min.css.map
|
||||
│ ├── bootstrap-reboot.css
|
||||
│ ├── bootstrap-reboot.css.map
|
||||
│ ├── bootstrap-reboot.min.css
|
||||
│ ├── bootstrap-reboot.min.css.map
|
||||
│ ├── bootstrap-reboot.rtl.css
|
||||
│ ├── bootstrap-reboot.rtl.css.map
|
||||
│ ├── bootstrap-reboot.rtl.min.css
|
||||
│ ├── bootstrap-reboot.rtl.min.css.map
|
||||
│ ├── bootstrap-utilities.css
|
||||
│ ├── bootstrap-utilities.css.map
|
||||
│ ├── bootstrap-utilities.min.css
|
||||
│ ├── bootstrap-utilities.min.css.map
|
||||
│ ├── bootstrap-utilities.rtl.css
|
||||
│ ├── bootstrap-utilities.rtl.css.map
|
||||
│ ├── bootstrap-utilities.rtl.min.css
|
||||
│ ├── bootstrap-utilities.rtl.min.css.map
|
||||
│ ├── bootstrap.css
|
||||
│ ├── bootstrap.css.map
|
||||
│ ├── bootstrap.min.css
|
||||
│ ├── bootstrap.min.css.map
|
||||
│ ├── bootstrap.rtl.css
|
||||
│ ├── bootstrap.rtl.css.map
|
||||
│ ├── bootstrap.rtl.min.css
|
||||
│ └── bootstrap.rtl.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
|
||||
```
|
||||
|
||||
This is the most basic form of Bootstrap: compiled 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://web.dev/articles/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/docs/v2/).
|
||||
|
||||
### CSS files
|
||||
|
||||
Bootstrap includes a handful of options for including some or all of our compiled CSS.
|
||||
|
||||
<BsTable class="table">
|
||||
| CSS files | Layout | Content | Components | Utilities |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| `bootstrap.css`<br/> `bootstrap.min.css`<br/> `bootstrap.rtl.css`<br/> `bootstrap.rtl.min.css` | Included | Included | Included | Included |
|
||||
| `bootstrap-grid.css`<br/> `bootstrap-grid.rtl.css`<br/> `bootstrap-grid.min.css`<br/> `bootstrap-grid.rtl.min.css` | [Only grid system]([[docsref:/layout/grid]]) | — | — | [Only flex utilities]([[docsref:/utilities/flex]]) |
|
||||
| `bootstrap-utilities.css`<br/> `bootstrap-utilities.rtl.css`<br/> `bootstrap-utilities.min.css`<br/> `bootstrap-utilities.rtl.min.css` | — | — | — | Included |
|
||||
| `bootstrap-reboot.css`<br/> `bootstrap-reboot.rtl.css`<br/> `bootstrap-reboot.min.css`<br/> `bootstrap-reboot.rtl.min.css` | — | [Only Reboot]([[docsref:/content/reboot]]) | — | — |
|
||||
</BsTable>
|
||||
|
||||
### JS files
|
||||
|
||||
Similarly, we have options for including some or all of our compiled JavaScript.
|
||||
|
||||
<BsTable class="table">
|
||||
| JS Files | Popper |
|
||||
| --- | --- |
|
||||
| `bootstrap.bundle.js`<br/> `bootstrap.bundle.min.js`<br/> | Included |
|
||||
| `bootstrap.js`<br/> `bootstrap.min.js`<br/> | – |
|
||||
</BsTable>
|
||||
|
||||
## Bootstrap source code
|
||||
|
||||
The Bootstrap source code download includes the compiled CSS and JavaScript assets, along with source Sass, JavaScript, and documentation. More specifically, it includes the following and more:
|
||||
|
||||
```text
|
||||
bootstrap/
|
||||
├── dist/
|
||||
│ ├── css/
|
||||
│ └── js/
|
||||
├── site/
|
||||
│ └──content/
|
||||
│ └── docs/
|
||||
│ └── [[config:docs_version]]/
|
||||
│ └── examples/
|
||||
├── js/
|
||||
└── scss/
|
||||
```
|
||||
|
||||
The `scss/` and `js/` are the source code for our CSS and JavaScript. The `dist/` folder includes everything listed in the compiled download section above. The `site/content/docs/` folder includes the source code for our hosted documentation, including our live examples of Bootstrap usage.
|
||||
|
||||
Beyond that, any other included file provides support for packages, license information, and development.
|
||||
Reference in New Issue
Block a user