rooty/Bootstrap
0
0
Fork 0
mirror of https://github.com/twbs/bootstrap.git synced 2024-12-12 00:08:59 +01:00
Code Issues Actions Packages Releases Activity
8df9899e98
Bootstrap/site/content/docs/5.3/getting-started/introduction.md

156 lines
7.4 KiB
Markdown
Raw Normal View History

new getting started intro overview doodad
2015-08-10 07:48:33 +02:00
---
Massive cleanup - Simpler main nav on all pages - Back to purple masthead on homepage instead of dark graphite - Active link styles on the main nav - Cleaned up sidebar nav - New docs layout name - Homepage copy edits - Updated bright purple docs color
2015-08-15 07:45:55 +02:00
layout: docs
Rewrite Getting Started > Introduction page to be more guide-like (#36204) * Rewrite Getting Started > Introduction page to be more guide-like * Add tabs, mention offcanvas for navbar
2022-04-21 07:27:28 +02:00
title: Get started with Bootstrap
description: Bootstrap is a powerful, feature-packed frontend toolkit. Build anything—from prototype to production—in minutes.
new getting started intro overview doodad
2015-08-10 07:48:33 +02:00
group: getting-started
Switch to Hugo. No more Ruby dependency and most important more than 10 times less build time (at least on Windows)!
2019-01-08 17:33:28 +01:00
aliases:
Release v5.3.0-alpha1 (#37661) * Bump version to 5.3.0-alpha1 * Dist * Add docs versions updates * Update note in homepage hero Co-authored-by: Mark Otto <markdotto@gmail.com>
2022-12-24 17:37:22 +01:00
- "/docs/5.3/getting-started/"
Add a few more redirects.
2018-12-30 16:08:28 +01:00
- "/docs/getting-started/"
- "/getting-started/"
swap kramdown toc for jekyll-toc plugin, update page layout to only show on xl and above
2017-05-28 06:44:42 +02:00
toc: true
new getting started intro overview doodad
2015-08-10 07:48:33 +02:00
---
## Quick start
Rewrite Getting Started > Introduction page to be more guide-like (#36204) * Rewrite Getting Started > Introduction page to be more guide-like * Add tabs, mention offcanvas for navbar
2022-04-21 07:27:28 +02:00
Get started by including Bootstrap's production-ready CSS and JavaScript via CDN without the need for any build steps. See it in practice with this [Bootstrap CodePen demo](https://codepen.io/team/bootstrap/pen/qBamdLj).
new getting started intro overview doodad
2015-08-10 07:48:33 +02:00
Rewrite Getting Started > Introduction page to be more guide-like (#36204) * Rewrite Getting Started > Introduction page to be more guide-like * Add tabs, mention offcanvas for navbar
2022-04-21 07:27:28 +02:00
<br>
Require quick start to be more explicit about CSS and JS
2017-10-03 02:32:30 +02:00
Update introduction.md Juste a quotation mark.
2022-05-20 14:09:54 +02:00
1. **Create a new `index.html` file in your project root.** Include the `<meta name="viewport">` tag as well for [proper responsive behavior](https://developer.mozilla.org/en-US/docs/Web/HTML/Viewport_meta_tag) in mobile devices.
new getting started intro overview doodad
2015-08-10 07:48:33 +02:00
Rewrite Getting Started > Introduction page to be more guide-like (#36204) * Rewrite Getting Started > Introduction page to be more guide-like * Add tabs, mention offcanvas for navbar
2022-04-21 07:27:28 +02:00
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Bootstrap demo</title>
</head>
<body>
<h1>Hello, world!</h1>
</body>
</html>
```
new getting started intro overview doodad
2015-08-10 07:48:33 +02:00
Rewrite Getting Started > Introduction page to be more guide-like (#36204) * Rewrite Getting Started > Introduction page to be more guide-like * Add tabs, mention offcanvas for navbar
2022-04-21 07:27:28 +02:00
2. **Include Bootstrap's CSS and JS.** Place the `<link>` tag in the `<head>` for our CSS, and the `<script>` tag for our JavaScript bundle (including Popper for positioning dropdowns, poppers, and tooltips) before the closing `</body>`. Learn more about our [CDN links](#cdn-links).
Require quick start to be more explicit about CSS and JS
2017-10-03 02:32:30 +02:00
Rewrite Getting Started > Introduction page to be more guide-like (#36204) * Rewrite Getting Started > Introduction page to be more guide-like * Add tabs, mention offcanvas for navbar
2022-04-21 07:27:28 +02:00
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Bootstrap demo</title>
<link href="{{< param "cdn.css" >}}" rel="stylesheet" integrity="{{< param "cdn.css_hash" >}}" crossorigin="anonymous">
</head>
<body>
<h1>Hello, world!</h1>
<script src="{{< param "cdn.js_bundle" >}}" integrity="{{< param "cdn.js_bundle_hash" >}}" crossorigin="anonymous"></script>
</body>
</html>
```
Rewrite quick start JS sections in getting started page so things are more clearly organized
2020-09-15 00:19:29 +02:00
Rewrite Getting Started > Introduction page to be more guide-like (#36204) * Rewrite Getting Started > Introduction page to be more guide-like * Add tabs, mention offcanvas for navbar
2022-04-21 07:27:28 +02:00
You can also include [Popper](https://popper.js.org/) and our JS separately. If you don't plan to use dropdowns, popovers, or tooltips, save some kilobytes by not including Popper.
Rewrite quick start JS sections in getting started page so things are more clearly organized
2020-09-15 00:19:29 +02:00
Rewrite Getting Started > Introduction page to be more guide-like (#36204) * Rewrite Getting Started > Introduction page to be more guide-like * Add tabs, mention offcanvas for navbar
2022-04-21 07:27:28 +02:00
```html
<script src="{{< param "cdn.popper" >}}" integrity="{{< param "cdn.popper_hash" >}}" crossorigin="anonymous"></script>
<script src="{{< param "cdn.js" >}}" integrity="{{< param "cdn.js_hash" >}}" crossorigin="anonymous"></script>
```
docs: mention our bundle file clearly. Note that we are using the bundle file already in our docs since 787441d.
2020-07-14 18:21:39 +02:00
Rewrite Getting Started > Introduction page to be more guide-like (#36204) * Rewrite Getting Started > Introduction page to be more guide-like * Add tabs, mention offcanvas for navbar
2022-04-21 07:27:28 +02:00
3. **Hello, world!** Open the page in your browser of choice to see your Bootstrapped page. Now you can start building with Bootstrap by creating your own [layout]({{< docsref "/layout/grid" >}}), adding dozens of [components]({{< docsref "/components/buttons" >}}), and utilizing [our official examples]({{< docsref "/examples" >}}).
new getting started intro overview doodad
2015-08-10 07:48:33 +02:00
Rewrite Getting Started > Introduction page to be more guide-like (#36204) * Rewrite Getting Started > Introduction page to be more guide-like * Add tabs, mention offcanvas for navbar
2022-04-21 07:27:28 +02:00
## CDN links
Rewrite quick start JS sections in getting started page so things are more clearly organized
2020-09-15 00:19:29 +02:00
Rewrite Getting Started > Introduction page to be more guide-like (#36204) * Rewrite Getting Started > Introduction page to be more guide-like * Add tabs, mention offcanvas for navbar
2022-04-21 07:27:28 +02:00
As reference, here are our primary CDN links.
Rewrite quick start JS sections in getting started page so things are more clearly organized
2020-09-15 00:19:29 +02:00
Rewrite Getting Started > Introduction page to be more guide-like (#36204) * Rewrite Getting Started > Introduction page to be more guide-like * Add tabs, mention offcanvas for navbar
2022-04-21 07:27:28 +02:00
{{< bs-table >}}
| Description | URL |
| --- | --- |
| CSS | `{{< param "cdn.css" >}}` |
| JS | `{{< param "cdn.js_bundle" >}}` |
{{< /bs-table >}}
You can also use the CDN to fetch any of our [additional builds listed in the Contents page]({{< docsref "/getting-started/contents" >}}).
## Next steps
- Read a bit more about some [important global environment settings](#important-globals) that Bootstrap utilizes.
Make docs clearer by dropping precompiled for compiled
2022-09-01 20:48:34 +02:00
- 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.
Rewrite Getting Started > Introduction page to be more guide-like (#36204) * Rewrite Getting Started > Introduction page to be more guide-like * Add tabs, mention offcanvas for navbar
2022-04-21 07:27:28 +02:00
- Need a little more power? Consider building with Bootstrap by [including the source files via package manager]({{< docsref "/getting-started/download#package-managers" >}}).
- Looking to use Bootstrap as a module with `<script type="module">`? Please refer to our [using Bootstrap as a module]({{< docsref "/getting-started/javascript#using-bootstrap-as-a-module" >}}) section.
add docs about how to use the esm version
2019-03-03 11:01:29 +01:00
Rewrite Getting Started > Introduction page to be more guide-like (#36204) * Rewrite Getting Started > Introduction page to be more guide-like * Add tabs, mention offcanvas for navbar
2022-04-21 07:27:28 +02:00
## JS components
Require quick start to be more explicit about CSS and JS
2017-10-03 02:32:30 +02:00
introduction: drop `details` element (#38995) * introduction: drop `details` element * Update introduction.md
2023-08-02 20:12:06 +02:00
Curious which components explicitly require our JavaScript and Popper? If you're at all unsure about the general page structure, keep reading for an example page template.
Add additional wording to the Introduction section of Bootstrap docs about the bootstrap bundle js (#26688)
2018-06-11 15:14:02 +02:00
Partially revert "Move this to a partial to work around the stray `p` issue." (#32076) This partially reverts commit 23ddfa99a33c81916666326e0cfd2582dacfca44.
2020-11-08 19:36:46 +01:00
- Alerts for dismissing
- Buttons for toggling states and checkbox/radio functionality
- Carousel for all slide behaviors, controls, and indicators
- Collapse for toggling visibility of content
Be consistent with Popper's name. (#32224) The npm package is named "popper.js" but the project is named "Popper", so use the latter consistently.
2020-11-21 15:22:08 +01:00
- Dropdowns for displaying and positioning (also requires [Popper](https://popper.js.org/))
Partially revert "Move this to a partial to work around the stray `p` issue." (#32076) This partially reverts commit 23ddfa99a33c81916666326e0cfd2582dacfca44.
2020-11-08 19:36:46 +01:00
- Modals for displaying, positioning, and scroll behavior
Rewrite Getting Started > Introduction page to be more guide-like (#36204) * Rewrite Getting Started > Introduction page to be more guide-like * Add tabs, mention offcanvas for navbar
2022-04-21 07:27:28 +02:00
- Navbar for extending our Collapse and Offcanvas plugins to implement responsive behaviors
- Navs with the Tab plugin for toggling content panes
Add offcanvas to the components requiring JavaScript (#35013) Co-authored-by: XhmikosR <xhmikosr@gmail.com>
2021-09-28 11:33:33 +02:00
- Offcanvases for displaying, positioning, and scroll behavior
Doc: Reorder alphabetically lists of components
2022-04-06 15:42:05 +02:00
- Scrollspy for scroll behavior and navigation updates
Partially revert "Move this to a partial to work around the stray `p` issue." (#32076) This partially reverts commit 23ddfa99a33c81916666326e0cfd2582dacfca44.
2020-11-08 19:36:46 +01:00
- Toasts for displaying and dismissing
Be consistent with Popper's name. (#32224) The npm package is named "popper.js" but the project is named "Popper", so use the latter consistently.
2020-11-21 15:22:08 +01:00
- Tooltips and popovers for displaying and positioning (also requires [Popper](https://popper.js.org/))
new getting started intro overview doodad
2015-08-10 07:48:33 +02:00
mention globals in intro page
2015-08-10 20:02:39 +02:00
## Important globals
Rewrite Getting Started > Introduction page to be more guide-like (#36204) * Rewrite Getting Started > Introduction page to be more guide-like * Add tabs, mention offcanvas for navbar
2022-04-21 07:27:28 +02:00
Bootstrap employs a handful of important global styles and settings, all of which are almost exclusively geared towards the *normalization* of cross browser styles. Let's dive in.
mention globals in intro page
2015-08-10 20:02:39 +02:00
### HTML5 doctype
Rewrite Getting Started > Introduction page to be more guide-like (#36204) * Rewrite Getting Started > Introduction page to be more guide-like * Add tabs, mention offcanvas for navbar
2022-04-21 07:27:28 +02:00
Bootstrap requires the use of the HTML5 doctype. Without it, you'll see some funky and incomplete styling.
mention globals in intro page
2015-08-10 20:02:39 +02:00
docs: switch to fenced codeblocks (#31806)
2020-10-19 11:56:49 +02:00
```html
Switch to lowercase `doctype`. (#24217) Having it uppercase doesn't offer anything and the lowercase version slightly improves gzip compression.
2017-10-03 18:34:59 +02:00
<!doctype html>
mention globals in intro page
2015-08-10 20:02:39 +02:00
<html lang="en">
...
</html>
docs: switch to fenced codeblocks (#31806)
2020-10-19 11:56:49 +02:00
```
mention globals in intro page
2015-08-10 20:02:39 +02:00
Attempt to fix focus ring being cut off in table of contents (#37965) * Attempt to fix focus ring being cut off in table of contents * Update _toc.scss --------- Co-authored-by: Patrick H. Lauke <redux@splintered.co.uk>
2023-02-14 17:58:08 +01:00
### Viewport meta
mention globals in intro page
2015-08-10 20:02:39 +02:00
Rewrite Getting Started > Introduction page to be more guide-like (#36204) * Rewrite Getting Started > Introduction page to be more guide-like * Add tabs, mention offcanvas for navbar
2022-04-21 07:27:28 +02:00
Bootstrap is developed *mobile first*, a strategy in which we optimize code for mobile devices first and then scale up components as necessary using CSS media queries. To ensure proper rendering and touch zooming for all devices, add the responsive viewport meta tag to your `<head>`.
mention globals in intro page
2015-08-10 20:02:39 +02:00
docs: switch to fenced codeblocks (#31806)
2020-10-19 11:56:49 +02:00
```html
Remove the now unneeded `shrink-to-fit` directive. (#28314)
2019-02-27 16:47:41 +01:00
<meta name="viewport" content="width=device-width, initial-scale=1">
docs: switch to fenced codeblocks (#31806)
2020-10-19 11:56:49 +02:00
```
mention globals in intro page
2015-08-10 20:02:39 +02:00
Rewrite Getting Started > Introduction page to be more guide-like (#36204) * Rewrite Getting Started > Introduction page to be more guide-like * Add tabs, mention offcanvas for navbar
2022-04-21 07:27:28 +02:00
You can see an example of this in action in the [quick start](#quick-start).
mention globals in intro page
2015-08-10 20:02:39 +02:00
### Box-sizing
Grammatically update the doc (#33267) * Grammatically update the doc * Apply suggestions from code review Co-authored-by: Mark Otto <otto@github.com>
2021-03-11 04:05:03 +01:00
For more straightforward sizing in CSS, we switch the global `box-sizing` value from `content-box` to `border-box`. This ensures `padding` does not affect the final computed width of an element, but it can cause problems with some third-party software like Google Maps and Google Custom Search Engine.
mention globals in intro page
2015-08-10 20:02:39 +02:00
On the rare occasion you need to override it, use something like the following:
docs: switch to fenced codeblocks (#31806)
2020-10-19 11:56:49 +02:00
```css
mention globals in intro page
2015-08-10 20:02:39 +02:00
.selector-for-some-widget {
Documentation cleanup (inc. use of <input ... readonly> for static form controls example) * Fix incorrect code indentation * Remove unnecessary vendor prefix for `box-sizing` - all modern browsers now support this unprefixed * Remove incorrect `<label>` and change static controls to readonly inputs * Allow `<img>` elements without `src` to allow for `holder.js` images used in the docs, which lack `src` and use `data-src` instead
2017-04-28 00:57:10 +02:00
box-sizing: content-box;
mention globals in intro page
2015-08-10 20:02:39 +02:00
}
docs: switch to fenced codeblocks (#31806)
2020-10-19 11:56:49 +02:00
```
mention globals in intro page
2015-08-10 20:02:39 +02:00
Use CSS3 pseudo elements in documentation
2017-09-08 02:06:02 +02:00
With the above snippet, nested elements—including generated content via `::before` and `::after`—will all inherit the specified `box-sizing` for that `.selector-for-some-widget`.
mention globals in intro page
2015-08-10 20:02:39 +02:00
Learn more about [box model and sizing at CSS Tricks](https://css-tricks.com/box-sizing/).
Drop Normalize, port relevant parts to Reboot (#21741) * Get this party started by removing mention of Normalize.css * Nuke the old comment, consolidate to a single line and number as appropriate * Bring over styles for HTML element from Normalize to Reboot * Move margin override for body element from Normalize to Reboot * Drop the block reset for HTML5 elements in IE9- from Normalize given we dropped IE9 support * Building on previous commit, do the same thing for figure, figcaption, and main * Remove IE9- display from Normalize given our browser support * Drop IE8 figure margin because we're IE10+ * No need for the h1 overrides because we reset these font and margin styles anyway in _type.scss already * Drop Safari 6 b and strong normalization because we're Safari 8+ * Remove mark styles for IE9- from Normalize * Remove old iOS audio fixes from Normalize * Remove IE9- display for progress from Normalize * Remove more IE9- rules from Normalize * One more IE9- display removal for canvas element * Move pre overrides from Normalize to Reboot * Move over some link resets to Reboot, drop others - Move over background-color and text-decoration - Drop focus outline change given it affects the offset on hover of focused links * Move over more code element resets, consolidate with pre overrides, too * Move over sub and sup wholesale * Move over img normalization to Reboot * Move over SVG override too * - Drop dupe hidden, but add comment for it - Move over template - Move over summary * Remove bulk of @viewport comment * edit down that code comment * consolidate html-based normalizations * update comments * Consolidate abbr styles * move over more type elements * move over hr changes * move over form controls and more * move over button resets * move over firefox button changes * move over search changes and more * we nuke all these styles for fieldsets anyway, so outright remove them * no need for those, we override them * move over legend, fieldset, progress * line break * delete normalize file * linting * update comment * clarify docs mentions of normalize and reboot * remove normalize excludes from linter * remove normalize excludes from cli task * linting * callout license since we forked part of normalize * Improve comments, move table background reset to .table class instead of in reboot * trailing space
2017-01-21 23:14:25 +01:00
### Reboot
mention globals in intro page
2015-08-10 20:02:39 +02:00
Add a docsref shortcode. This allows for the build to fail if a reference isn't found.
2019-02-04 11:22:02 +01:00
For improved cross-browser rendering, we use [Reboot]({{< docsref "/content/reboot" >}}) to correct inconsistencies across browsers and devices while providing slightly more opinionated resets to common HTML elements.
rip community as separate page, move to intro and restore table of contents on intro
2015-08-10 20:11:35 +02:00
## Community
Fix typos after #36762 (#36771)
2022-07-29 21:49:01 +02:00
Stay up-to-date on the development of Bootstrap and reach out to the community with these helpful resources.
rip community as separate page, move to intro and restore table of contents on intro
2015-08-10 20:11:35 +02:00
docs: Move trailing URL slashes to the variables.
2019-07-26 16:06:17 +02:00
- Read and subscribe to [The Official Bootstrap Blog]({{< param blog >}}).
Docs: add Discord (community) and Bootstrap subreddit links (#38873) Co-authored-by: Rob Jones <robert@blumac.digital> Co-authored-by: Mark Otto <markdotto@gmail.com> Co-authored-by: Julien Déramond <juderamond@gmail.com>
2023-09-13 07:53:14 +02:00
- Ask questions and explore [our GitHub Discussions](https://github.com/twbs/bootstrap/discussions).
- Discuss, ask questions, and more on [the community Discord](https://discord.gg/bZUvakRU3M) or [Bootstrap subreddit](https://reddit.com/r/bootstrap).
Replace freenode with libera IRC server (#34050)
2021-05-21 07:08:04 +02:00
- Chat with fellow Bootstrappers in IRC. On the `irc.libera.chat` server, in the `#bootstrap` channel.
Fix Stack Overflow tag (#31062)
2020-06-18 11:56:57 +02:00
- Implementation help may be found at Stack Overflow (tagged [`bootstrap-5`](https://stackoverflow.com/questions/tagged/bootstrap-5)).
Grammatically update the doc (#33267) * Grammatically update the doc * Apply suggestions from code review Co-authored-by: Mark Otto <otto@github.com>
2021-03-11 04:05:03 +01:00
- Developers should use the keyword `bootstrap` on packages that modify or add to the functionality of Bootstrap when distributing through [npm](https://www.npmjs.com/search?q=keywords:bootstrap) or similar delivery mechanisms for maximum discoverability.
rip community as separate page, move to intro and restore table of contents on intro
2015-08-10 20:11:35 +02:00
Switch to Hugo. No more Ruby dependency and most important more than 10 times less build time (at least on Windows)!
2019-01-08 17:33:28 +01:00
You can also follow [@getbootstrap on Twitter](https://twitter.com/{{< param twitter >}}) for the latest gossip and awesome music videos.
Reference in New Issue Copy Permalink