root
/
bootstrap
mirror of https://github.com/twbs/bootstrap.git
1
0
Fork 0
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Make docs clearer by dropping precompiled for compiled

This commit is contained in:
Mark Otto 2022-09-01 11:48:34 -07:00 committed by Mark Otto
parent 4f97d8fabd
commit 2793637837
4 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.cspell.json
View File

@ -76,7 +76,6 @@
"Packagist", "Packagist",
"popperjs", "popperjs",
"prebuild", "prebuild",
"precompiled",
"prefersreducedmotion", "prefersreducedmotion",
"prepended", "prepended",
"printf", "printf",

16
site/content/docs/5.2/getting-started/contents.md
View File

@ -1,12 +1,12 @@
--- ---
layout: docs layout: docs
title: Contents title: Contents
description: Discover what's included in Bootstrap, including our precompiled and source code flavors. description: Discover what's included in Bootstrap, including our compiled and source code flavors.
group: getting-started group: getting-started
toc: true toc: true
--- ---
## Precompiled Bootstrap ## Compiled Bootstrap
Once downloaded, unzip the compressed folder and you'll see something like this: Once downloaded, unzip the compressed folder and you'll see something like this:
@ -62,9 +62,9 @@ bootstrap/
└── bootstrap.min.js.map └── bootstrap.min.js.map
``` ```
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/). 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://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 ### CSS files
Bootstrap includes a handful of options for including some or all of our compiled CSS. Bootstrap includes a handful of options for including some or all of our compiled CSS.
@ -77,7 +77,7 @@ Bootstrap includes a handful of options for including some or all of our compile
| `bootstrap-reboot.css`<br> `bootstrap-reboot.rtl.css`<br> `bootstrap-reboot.min.css`<br> `bootstrap-reboot.rtl.min.css` | — | [Only Reboot]({{< docsref "/content/reboot" >}}) | — | — | | `bootstrap-reboot.css`<br> `bootstrap-reboot.rtl.css`<br> `bootstrap-reboot.min.css`<br> `bootstrap-reboot.rtl.min.css` | — | [Only Reboot]({{< docsref "/content/reboot" >}}) | — | — |
{{< /bs-table >}} {{< /bs-table >}}
## JS files ### JS files
Similarly, we have options for including some or all of our compiled JavaScript. Similarly, we have options for including some or all of our compiled JavaScript.
@ -90,7 +90,7 @@ Similarly, we have options for including some or all of our compiled JavaScript.
## Bootstrap source code ## 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: 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 ```text
bootstrap/ bootstrap/
@ -106,4 +106,6 @@ bootstrap/
└── scss/ └── scss/
``` ```
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. 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.

2
site/content/docs/5.2/getting-started/download.md
View File

@ -68,7 +68,7 @@ The `bootstrap` module itself exports all of our plugins. You can manually load
Bootstrap's `package.json` contains some additional metadata under the following keys: Bootstrap's `package.json` contains some additional metadata under the following keys:
- `sass` - path to Bootstrap's main [Sass](https://sass-lang.com/) source file - `sass` - path to Bootstrap's main [Sass](https://sass-lang.com/) source file
- `style` - path to Bootstrap's non-minified CSS that's been precompiled using the default settings (no customization) - `style` - path to Bootstrap's non-minified CSS that's been compiled using the default settings (no customization)
{{< callout info >}} {{< callout info >}}
{{< partial "callout-info-npm-starter.md" >}} {{< partial "callout-info-npm-starter.md" >}}

2
site/content/docs/5.2/getting-started/introduction.md
View File

@ -76,7 +76,7 @@ You can also use the CDN to fetch any of our [additional builds listed in the Co
- Read a bit more about some [important global environment settings](#important-globals) that Bootstrap utilizes. - Read a bit more about some [important global environment settings](#important-globals) that Bootstrap utilizes.
- Read about what's included in Bootstrap in our [contents section]({{< docsref "/getting-started/contents#precompiled-bootstrap" >}}) and the list of [components that require JavaScript](#js-components) below. - Read about what's included in Bootstrap in our [contents section]({{< docsref "/getting-started/contents/" >}}) and the list of [components that require JavaScript](#js-components) below.
- Need a little more power? Consider building with Bootstrap by [including the source files via package manager]({{< docsref "/getting-started/download#package-managers" >}}). - Need a little more power? Consider building with Bootstrap by [including the source files via package manager]({{< docsref "/getting-started/download#package-managers" >}}).