-
-
Notifications
You must be signed in to change notification settings - Fork 78.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Update docs homepage to use separate partials for each section Also modifies the homepage code snippets under getting started to remove the code comments, making copy-pasting easier. * Update some copy and examples * newlines * type button * more code review, bring back interactive components * fix hover
- Loading branch information
Showing
10 changed files
with
382 additions
and
357 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,88 @@ | ||
<section class="pb-md-5 mb-5"> | ||
<div class="col-lg-8 mb-5"> | ||
<div class="masthead-followup-icon d-inline-block mb-3 me-2" style="--bg-rgb: var(--bs-danger-rgb);"> | ||
<svg class="bi fs-1"><use xlink:href="#menu-button-wide-fill"></use></svg> | ||
</div> | ||
<svg class="bi me-2 fs-2 text-muted"><use xlink:href="#plus"></use></svg> | ||
<div class="masthead-followup-icon d-inline-block mb-3" style="--bg-rgb: var(--bs-info-rgb);"> | ||
<svg class="bi fs-1"><use xlink:href="#braces-asterisk"></use></svg> | ||
</div> | ||
<h2 class="display-5 mb-3 fw-semibold lh-sm">Components, meet the Utility API</h2> | ||
<p class="lead fw-normal"> | ||
New in Bootstrap 5, our utilities are now generated by our <a href="/docs/{{ .Site.Params.docs_version }}/utilities/api/">Utility API</a>. We built it as a feature-packed Sass map that can be quickly and easily customized. It's never been easier to add, remove, or modify any utility classes. Make utilities responsive, add pseudo-class variants, and give them custom names. | ||
</p> | ||
</div> | ||
<div class="row gx-md-5"> | ||
<div class="col-lg-6"> | ||
<h3 class="fw-semibold">Quickly customize components</h3> | ||
<p>Apply any of our included utility classes to our components to customize their appearance, like the navigation example below. There are hundreds of classes available—from <a href="/docs/{{ .Site.Params.docs_version }}/utilities/position/">positioning</a> and <a href="/docs/{{ .Site.Params.docs_version }}/utilities/sizing/">sizing</a> to <a href="/docs/{{ .Site.Params.docs_version }}/utilities/colors/">colors</a> and <a href="/docs/{{ .Site.Params.docs_version }}/utilities/shadows/">effects</a>. Mix them with CSS variable overrides for even more control.</p> | ||
<div class="p-4 border rounded-3 mb-4"> | ||
<ul class="nav nav-pills mb-4" id="pillNav" role="tablist"> | ||
<li class="nav-item" role="presentation"> | ||
<button class="nav-link active" id="home-tab" data-bs-toggle="tab" type="button" role="tab" aria-selected="true">Home</button> | ||
</li> | ||
<li class="nav-item" role="presentation"> | ||
<button class="nav-link" id="profile-tab" data-bs-toggle="tab" type="button" role="tab" aria-selected="false">Profile</button> | ||
</li> | ||
<li class="nav-item" role="presentation"> | ||
<button class="nav-link" id="contact-tab" data-bs-toggle="tab" type="button" role="tab" aria-selected="false">Contact</button> | ||
</li> | ||
</ul> | ||
<ul class="nav nav-pills nav-fill gap-2 p-1 small bg-primary rounded-5 shadow-sm" id="pillNav2" role="tablist" style="--bs-nav-link-color: rgba(255, 255, 255, .75); --bs-nav-link-hover-color: #fff; --bs-nav-pills-link-active-color: var(--bs-primary); --bs-nav-pills-link-active-bg: var(--bs-white);"> | ||
<li class="nav-item" role="presentation"> | ||
<button class="nav-link active rounded-5" id="home-tab2" data-bs-toggle="tab" type="button" role="tab" aria-selected="true">Home</button> | ||
</li> | ||
<li class="nav-item" role="presentation"> | ||
<button class="nav-link rounded-5" id="profile-tab2" data-bs-toggle="tab" type="button" role="tab" aria-selected="false">Profile</button> | ||
</li> | ||
<li class="nav-item" role="presentation"> | ||
<button class="nav-link rounded-5" id="contact-tab2" data-bs-toggle="tab" type="button" role="tab" aria-selected="false">Contact</button> | ||
</li> | ||
</ul> | ||
</div> | ||
{{ highlight (printf `<ul class="nav nav-pills nav-fill gap-2 p-1 small bg-primary rounded-5 shadow-sm" id="pillNav2" role="tablist" style="--bs-nav-link-color: var(--bs-white); --bs-nav-pills-link-active-color: var(--bs-primary); --bs-nav-pills-link-active-bg: var(--bs-white);"> | ||
<li class="nav-item" role="presentation"> | ||
<button class="nav-link active rounded-5" id="home-tab2" data-bs-toggle="tab" type="button" role="tab" aria-selected="true">Home</button> | ||
</li> | ||
<li class="nav-item" role="presentation"> | ||
<button class="nav-link rounded-5" id="profile-tab2" data-bs-toggle="tab" type="button" role="tab" aria-selected="false">Profile</button> | ||
</li> | ||
<li class="nav-item" role="presentation"> | ||
<button class="nav-link rounded-5" id="contact-tab2" data-bs-toggle="tab" type="button" role="tab" aria-selected="false">Contact</button> | ||
</li> | ||
</ul> | ||
`) "html" "" }} | ||
<p class="d-flex justify-content-start mb-md-0"> | ||
<a href="/docs/{{ .Site.Params.docs_version }}/examples#snippets" class="icon-link fw-semibold"> | ||
Explore customized components | ||
<svg class="bi"><use xlink:href="#arrow-right-short"></use></svg> | ||
</a> | ||
</p> | ||
</div> | ||
<div class="col-lg-6"> | ||
<h3 class="fw-semibold">Create and extend utilities</h3> | ||
<p>Use Bootstrap's utility API to modify any of our included utilities or create your own custom utilities for any project. Import Bootstrap first, then use Sass map functions to modify, add, or remove utilities.</p> | ||
{{ highlight (printf `@import "bootstrap/scss/bootstrap"; | ||
|
||
$utilities: map-merge( | ||
$utilities, | ||
( | ||
"cursor": ( | ||
property: cursor, | ||
class: cursor, | ||
responsive: true, | ||
values: auto pointer grab, | ||
) | ||
) | ||
); | ||
`) "scss" "" }} | ||
|
||
<p class="d-flex justify-content-start mb-md-0"> | ||
<a href="/docs/{{ .Site.Params.docs_version }}/utilities/api/" class="icon-link fw-semibold mb-3"> | ||
Explore the utility API | ||
<svg class="bi"><use xlink:href="#arrow-right-short"></use></svg> | ||
</a> | ||
</p> | ||
</div> | ||
</div> | ||
</section> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
<section class="row g-md-5 pb-md-5 mb-5 align-items-center"> | ||
<div class="col-lg-8 mb-5"> | ||
<div class="masthead-followup-icon d-inline-block mb-3" style="--bg-rgb: var(--bd-pink-rgb);"> | ||
<svg class="bi fs-1"><use xlink:href="#braces"></use></svg> | ||
</div> | ||
<h2 class="display-5 mb-3 fw-semibold lh-sm">Build and extend in real-time with CSS variables</h2> | ||
<p class="lead fw-normal"> | ||
Bootstrap 5 is evolving with each release to better utilize CSS variables for global theme styles, individual components, and even utilities. We provide dozens of variables for colors, font styles, and more at a <code>:root</code> level for use anywhere. On components and utilities, CSS variables are scoped to the relevant class and can easily be modified. | ||
</p> | ||
<p class="d-flex align-items-start flex-column lead fw-normal mb-0"> | ||
<a href="/docs/{{ .Site.Params.docs_version }}/customize/css-variables/" class="icon-link fw-semibold mb-3"> | ||
Learn more about CSS variables | ||
<svg class="bi"><use xlink:href="#arrow-right-short"></use></svg> | ||
</a> | ||
</p> | ||
</div> | ||
<div class="row gx-md-5"> | ||
<div class="col-lg-6 mb-3"> | ||
<h3 class="fw-semibold">Using CSS variables</h3> | ||
<p>Use any of our <a href="/docs/{{ .Site.Params.docs_version }}/customize/css-variables/#root-variables">global <code>:root</code> variables</a> to write new styles. CSS variables use the <code>var(--bs-variableName)</code> syntax and can be inherited by children elements.</p> | ||
{{ highlight (printf `.component { | ||
color: var(--bs-gray-800); | ||
background-color: var(--bs-gray-100); | ||
border: 1px solid var(--bs-gray-200); | ||
border-radius: .25rem; | ||
} | ||
|
||
.component-header { | ||
color: var(--bs-purple); | ||
}`) "scss" "" }} | ||
</div> | ||
<div class="col-lg-6 mb-3"> | ||
<h3 class="fw-semibold">Customizing via CSS variables</h3> | ||
<p>Override global, component, or utility class variables to customize Bootstrap just how you like. No need to redeclare each rule, just a new variable value.</p> | ||
{{ highlight (printf `body { | ||
--bs-body-font-family: var(--bs-font-monospace); | ||
--bs-body-line-height: 1.4; | ||
--bs-body-bg: var(--bs-gray-100); | ||
} | ||
|
||
.table { | ||
--bs-table-color: var(--bs-gray-600); | ||
--bs-table-bg: var(--bs-gray-100); | ||
--bs-table-border-color: transparent; | ||
}`) "scss" "" }} | ||
</div> | ||
</div> | ||
</section> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
<section class="col-lg-7 mb-5"> | ||
<div class="masthead-followup-icon d-inline-block mb-3" style="--bg-rgb: var(--bs-primary-rgb);"> | ||
<svg class="bi fs-1"><use xlink:href="#palette2"></use></svg> | ||
</div> | ||
<h2 class="display-5 mb-3 fw-semibold lh-sm">Customize everything with Sass</h2> | ||
<p class="lead fw-normal"> | ||
Bootstrap utilizes Sass for a modular and customizable architecture. Import only the components you need, enable global options like gradients and shadows, and write your own CSS with our variables, maps, functions, and mixins. | ||
</p> | ||
<p class="d-flex justify-content-start lead fw-normal"> | ||
<a href="/docs/{{ .Site.Params.docs_version }}/customize/overview/" class="icon-link fw-semibold"> | ||
Learn more about customizing | ||
<svg class="bi"><use xlink:href="#arrow-right-short"></use></svg> | ||
</a> | ||
</p> | ||
</section> | ||
|
||
<section class="row g-md-5 mb-5 pb-md-5"> | ||
<div class="col-lg-6"> | ||
<h3>Include all of Bootstrap’s Sass</h3> | ||
<p>Import one stylesheet and you're off to the races with every feature of our CSS.</p> | ||
{{ highlight (printf `// Variable overrides first | ||
$primary: #900; | ||
$enable-shadows: true; | ||
$prefix: "mo-"; | ||
|
||
// Then import Bootstrap | ||
@import "../node_modules/bootstrap/scss/bootstrap"; | ||
`) "scss" "" }} | ||
<p>Learn more about our <a href="/docs/{{ .Site.Params.docs_version }}/customize/options/">global Sass options</a>.</p> | ||
</div> | ||
<div class="col-lg-6"> | ||
<h3>Include what you need</h3> | ||
<p>The easiest way to customize Bootstrap—include only the CSS you need.</p> | ||
{{ highlight (printf `// Functions first | ||
@import "../node_modules/bootstrap/scss/functions"; | ||
|
||
// Variable overrides second | ||
$primary: #900; | ||
$enable-shadows: true; | ||
$prefix: "mo-"; | ||
|
||
// Required Bootstrap imports | ||
@import "../node_modules/bootstrap/scss/variables"; | ||
@import "../node_modules/bootstrap/scss/maps"; | ||
@import "../node_modules/bootstrap/scss/mixins"; | ||
@import "../node_modules/bootstrap/scss/root"; | ||
|
||
// Optional components | ||
@import "../node_modules/bootstrap/scss/utilities"; | ||
@import "../node_modules/bootstrap/scss/reboot"; | ||
@import "../node_modules/bootstrap/scss/containers"; | ||
@import "../node_modules/bootstrap/scss/grid"; | ||
@import "../node_modules/bootstrap/scss/helpers"; | ||
@import "../node_modules/bootstrap/scss/utilities/api"; | ||
`) "scss" "" }} | ||
<p>Learn more about <a href="/docs/{{ .Site.Params.docs_version }}/customize/sass/">using Bootstrap with Sass</a>.</p> | ||
</div> | ||
</section> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
<div class="col-lg-7 mx-auto pb-3 mb-3 mb-md-5 text-md-center"> | ||
<div class="masthead-followup-icon d-inline-block mb-3" style="--bg-rgb: var(--bd-violet-rgb);"> | ||
<svg class="bi fs-1"><use xlink:href="#code"></use></svg> | ||
</div> | ||
<h2 class="display-5 mb-3 fw-semibold lh-sm">Get started any way you want</h2> | ||
<p class="lead fw-normal"> | ||
Jump right into building with Bootstrap—use the CDN, install it via package manager, or download the source code. | ||
</p> | ||
<p class="d-flex justify-content-md-start justify-content-md-center lead fw-normal"> | ||
<a href="/docs/{{ .Site.Params.docs_version }}/getting-started/download/" class="icon-link fw-semibold justify-content-center ps-md-4"> | ||
Read installation docs | ||
<svg class="bi"><use xlink:href="#arrow-right-short"></use></svg> | ||
</a> | ||
</p> | ||
</div> | ||
|
||
<section class="row g-3 g-md-5 mb-5 pb-5 justify-content-center"> | ||
<div class="col-lg-6 py-lg-4 pe-lg-5"> | ||
<svg class="bi mb-2 fs-2 text-muted"><use xlink:href="#box-seam"></use></svg> | ||
<h3 class="fw-semibold">Install via package manager</h3> | ||
<p class="pe-lg-5"> | ||
Install Bootstrap’s source Sass and JavaScript files via npm, RubyGems, Composer, or Meteor. Package managed installs don’t include documentation or our full build scripts. You can also <a href="https://github.com/twbs/bootstrap-npm-starter">use our npm template repo</a> to quickly generate a Bootstrap project via npm. | ||
</p> | ||
{{ highlight (printf ("npm install bootstrap@%s") .Site.Params.current_version) "sh" "" }} | ||
{{ highlight (printf ("gem install bootstrap -v %s") .Site.Params.current_ruby_version) "sh" "" }} | ||
<p> | ||
<a href="/docs/{{ .Site.Params.docs_version }}/getting-started/download/">Read our installation docs</a> for more info and additional package managers. | ||
</p> | ||
</div> | ||
<div class="col-lg-6 py-lg-4 ps-lg-5 border-lg-start"> | ||
<svg class="bi mb-2 fs-2 text-muted"><use xlink:href="#globe2"></use></svg> | ||
<h3 class="fw-semibold">Include via CDN</h3> | ||
<p class="pe-lg-5"> | ||
When you only need to include Bootstrap’s compiled CSS or JS, you can use <a href="https://www.jsdelivr.com/package/npm/bootstrap">jsDelivr</a>. See it in action with our simple <a href="/docs/{{ .Site.Params.docs_version }}/getting-started/introduction/#quick-start">quick start</a>, or <a href="/docs/{{ .Site.Params.docs_version }}/examples/">browse the examples</a> to jumpstart your next project. You can also choose to include Popper and our JS <a href="/docs/{{ .Site.Params.docs_version }}/getting-started/introduction/#separate">separately</a>. | ||
</p> | ||
{{ highlight (printf (`<link href="%s" rel="stylesheet" integrity=%q crossorigin="anonymous">`) .Site.Params.cdn.css (.Site.Params.cdn.css_hash | safeHTMLAttr)) "html" "" }} | ||
{{ highlight (printf (`<script src="%s" integrity=%q crossorigin="anonymous"></script>`) .Site.Params.cdn.js_bundle (.Site.Params.cdn.js_bundle_hash | safeHTMLAttr)) "html" "" }} | ||
</div> | ||
|
||
<div class="col-md-8 mx-auto text-center"> | ||
<h4 class="fw-semibold">Read our getting started guides</h4> | ||
<p>Get a jump on including Bootstrap's source files in a new project with our official guides.</p> | ||
<div class="d-flex flex-wrap align-items-center justify-content-center gap-4 mt-4"> | ||
<a class="d-flex flex-column align-items-center text-decoration-none animate-img" href="/docs/{{ .Site.Params.docs_version }}/getting-started/webpack"> | ||
<img class="d-block mb-2" src="/docs/{{ .Site.Params.docs_version }}/assets/img/webpack.svg" alt="" width="72" height="72" loading="lazy"> | ||
<span class="text-muted">Webpack</span> | ||
</a> | ||
<a class="d-flex flex-column align-items-center text-decoration-none animate-img" href="/docs/{{ .Site.Params.docs_version }}/getting-started/parcel"> | ||
<img class="d-block mb-2" src="/docs/{{ .Site.Params.docs_version }}/assets/img/parcel.png" alt="" width="72" height="72" loading="lazy"> | ||
<span class="text-muted">Parcel</span> | ||
</a> | ||
<a class="d-flex flex-column align-items-center text-decoration-none animate-img" href="/docs/{{ .Site.Params.docs_version }}/getting-started/vite"> | ||
<img class="d-block mb-2" src="/docs/{{ .Site.Params.docs_version }}/assets/img/vite.svg" alt="" width="72" height="72" loading="lazy"> | ||
<span class="text-muted">Vite</span> | ||
</a> | ||
</div> | ||
</div> | ||
</section> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
<section class="row g-3 g-md-5 pb-md-5 mb-5 align-items-center"> | ||
<div class="col-lg-6"> | ||
<div class="masthead-followup-icon d-inline-block mb-3" style="--bg-rgb: var(--bd-teal-rgb);"> | ||
{{ partial "icons/circle-square.svg" (dict "width" "32" "height" "32") }} | ||
</div> | ||
<h2 class="display-5 mb-3 fw-semibold lh-sm">Personalize it with Bootstrap Icons</h2> | ||
<p class="lead fw-normal"> | ||
<a href="{{ .Site.Params.icons }}">Bootstrap Icons</a> is an open source SVG icon library featuring over 1,800 glyphs, with more added every release. They're designed to work in any project, whether you use Bootstrap itself or not. Use them as SVGs or icon fonts—both options give you vector scaling and easy customization via CSS. | ||
</p> | ||
<p class="d-flex justify-content-start lead fw-normal mb-md-0"> | ||
<a href="{{ .Site.Params.icons }}" class="icon-link fw-semibold"> | ||
Get Bootstrap Icons | ||
<svg class="bi"><use xlink:href="#arrow-right-short"></use></svg> | ||
</a> | ||
</p> | ||
</div> | ||
<div class="col-lg-6"> | ||
<img class="img-fluid mt-3 mx-auto" srcset="/docs/{{ .Site.Params.docs_version }}/assets/img/bootstrap-icons.png, | ||
/docs/{{ .Site.Params.docs_version }}/assets/img/bootstrap-icons@2x.png 2x" | ||
src="/docs/{{ .Site.Params.docs_version }}/assets/img/bootstrap-icons.png" | ||
alt="Bootstrap Icons" width="700" height="425" loading="lazy"> | ||
</div> | ||
</section> |
Oops, something went wrong.