From aaff11a0b321e7c1b93c089e709ee92d01a4b6f6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABl=20Poupard?= Date: Tue, 9 Jun 2020 16:44:20 +0300 Subject: [PATCH] docs(examples): new cheatsheet and RTL examples --- README.md | 77 +- config.yml | 2 + site/content/docs/5.0/about/team.md | 2 +- .../content/docs/5.0/components/breadcrumb.md | 2 +- .../docs/5.0/components/button-group.md | 6 +- site/content/docs/5.0/components/buttons.md | 2 +- site/content/docs/5.0/components/card.md | 2 +- site/content/docs/5.0/components/dropdowns.md | 59 +- .../content/docs/5.0/components/list-group.md | 20 +- site/content/docs/5.0/components/modal.md | 16 +- site/content/docs/5.0/components/navbar.md | 38 +- site/content/docs/5.0/components/navs-tabs.md | 4 +- site/content/docs/5.0/components/popovers.md | 2 +- site/content/docs/5.0/components/scrollspy.md | 18 +- site/content/docs/5.0/components/spinners.md | 4 +- site/content/docs/5.0/components/toasts.md | 40 +- site/content/docs/5.0/components/tooltips.md | 2 +- site/content/docs/5.0/content/figures.md | 2 +- site/content/docs/5.0/content/images.md | 4 +- site/content/docs/5.0/content/typography.md | 2 +- site/content/docs/5.0/customize/options.md | 2 +- site/content/docs/5.0/examples/_index.md | 9 +- .../docs/5.0/examples/album-rtl/index.html | 209 +++ .../docs/5.0/examples/album/index.html | 4 +- .../docs/5.0/examples/blog-rtl/blog-rtl.css | 6 + .../docs/5.0/examples/blog-rtl/index.html | 203 +++ .../examples/carousel-rtl/carousel-rtl.css | 8 + .../docs/5.0/examples/carousel-rtl/index.html | 168 ++ .../docs/5.0/examples/carousel/index.html | 10 +- .../5.0/examples/cheatsheet-rtl/index.html | 1614 +++++++++++++++++ .../5.0/examples/cheatsheet/cheatsheet.css | 173 ++ .../5.0/examples/cheatsheet/cheatsheet.js | 68 + .../docs/5.0/examples/cheatsheet/index.html | 1613 ++++++++++++++++ .../docs/5.0/examples/checkout-rtl/index.html | 232 +++ .../docs/5.0/examples/cover/index.html | 4 +- .../examples/dashboard-rtl/dashboard-rtl.css | 14 + .../5.0/examples/dashboard-rtl/dashboard.js | 53 + .../5.0/examples/dashboard-rtl/index.html | 254 +++ .../docs/5.0/examples/dashboard/index.html | 6 +- .../docs/5.0/examples/masonry/index.html | 2 +- .../docs/5.0/examples/navbar-fixed/index.html | 4 +- .../5.0/examples/navbar-static/index.html | 4 +- .../docs/5.0/examples/navbars/index.html | 20 +- .../docs/5.0/examples/offcanvas/index.html | 22 +- .../docs/5.0/examples/pricing/index.html | 4 +- .../docs/5.0/examples/product/index.html | 24 +- .../5.0/examples/starter-template/index.html | 4 +- .../examples/sticky-footer-navbar/index.html | 4 +- site/content/docs/5.0/forms/input-group.md | 6 +- .../docs/5.0/getting-started/build-tools.md | 4 + .../docs/5.0/getting-started/contents.md | 26 +- site/content/docs/5.0/getting-started/rtl.md | 138 ++ site/content/docs/5.0/helpers/clearfix.md | 4 +- .../docs/5.0/helpers/stretched-link.md | 4 +- site/content/docs/5.0/layout/columns.md | 12 +- site/content/docs/5.0/layout/utilities.md | 2 +- site/content/docs/5.0/migration.md | 44 + site/content/docs/5.0/utilities/api.md | 31 +- site/content/docs/5.0/utilities/borders.md | 12 +- site/content/docs/5.0/utilities/flex.md | 6 +- site/content/docs/5.0/utilities/float.md | 16 +- site/content/docs/5.0/utilities/overflow.md | 6 +- site/content/docs/5.0/utilities/position.md | 46 +- site/content/docs/5.0/utilities/spacing.md | 6 +- site/content/docs/5.0/utilities/text.md | 18 +- site/data/examples.yml | 18 + site/data/sidebar.yml | 1 + site/layouts/_default/docs.html | 6 +- site/layouts/_default/examples.html | 2 +- site/layouts/_default/single.html | 2 +- site/layouts/partials/docs-navbar.html | 14 +- site/layouts/partials/docs-subnav.html | 4 +- site/layouts/partials/docs-versions.html | 4 +- site/layouts/partials/footer.html | 10 +- .../partials/home/masthead-followup.html | 8 +- site/layouts/partials/home/masthead.html | 4 +- site/layouts/partials/stylesheet.html | 8 +- .../5.0/assets/img/examples/album-rtl.png | Bin 0 -> 6392 bytes .../5.0/assets/img/examples/album-rtl@2x.png | Bin 0 -> 15450 bytes .../docs/5.0/assets/img/examples/blog-rtl.png | Bin 0 -> 12545 bytes .../5.0/assets/img/examples/blog-rtl@2x.png | Bin 0 -> 31035 bytes .../5.0/assets/img/examples/carousel-rtl.png | Bin 0 -> 10344 bytes .../assets/img/examples/carousel-rtl@2x.png | Bin 0 -> 24535 bytes .../assets/img/examples/cheatsheet-rtl.png | Bin 0 -> 6089 bytes .../assets/img/examples/cheatsheet-rtl@2x.png | Bin 0 -> 13863 bytes .../5.0/assets/img/examples/cheatsheet.png | Bin 0 -> 8132 bytes .../5.0/assets/img/examples/cheatsheet@2x.png | Bin 0 -> 19324 bytes .../5.0/assets/img/examples/checkout-rtl.png | Bin 0 -> 8848 bytes .../assets/img/examples/checkout-rtl@2x.png | Bin 0 -> 21965 bytes .../docs/5.0/assets/img/examples/checkout.png | Bin 25151 -> 9884 bytes .../5.0/assets/img/examples/checkout@2x.png | Bin 28180 -> 25985 bytes .../5.0/assets/img/examples/dashboard-rtl.png | Bin 0 -> 8261 bytes .../assets/img/examples/dashboard-rtl@2x.png | Bin 0 -> 19399 bytes .../docs/5.0/assets/img/examples/sign-in.png | Bin 5704 -> 2501 bytes .../5.0/assets/img/examples/sign-in@2x.png | Bin 5680 -> 5240 bytes 95 files changed, 5206 insertions(+), 298 deletions(-) create mode 100644 site/content/docs/5.0/examples/album-rtl/index.html create mode 100644 site/content/docs/5.0/examples/blog-rtl/blog-rtl.css create mode 100644 site/content/docs/5.0/examples/blog-rtl/index.html create mode 100644 site/content/docs/5.0/examples/carousel-rtl/carousel-rtl.css create mode 100644 site/content/docs/5.0/examples/carousel-rtl/index.html create mode 100644 site/content/docs/5.0/examples/cheatsheet-rtl/index.html create mode 100644 site/content/docs/5.0/examples/cheatsheet/cheatsheet.css create mode 100644 site/content/docs/5.0/examples/cheatsheet/cheatsheet.js create mode 100644 site/content/docs/5.0/examples/cheatsheet/index.html create mode 100644 site/content/docs/5.0/examples/checkout-rtl/index.html create mode 100644 site/content/docs/5.0/examples/dashboard-rtl/dashboard-rtl.css create mode 100644 site/content/docs/5.0/examples/dashboard-rtl/dashboard.js create mode 100644 site/content/docs/5.0/examples/dashboard-rtl/index.html create mode 100644 site/content/docs/5.0/getting-started/rtl.md create mode 100644 site/static/docs/5.0/assets/img/examples/album-rtl.png create mode 100644 site/static/docs/5.0/assets/img/examples/album-rtl@2x.png create mode 100644 site/static/docs/5.0/assets/img/examples/blog-rtl.png create mode 100644 site/static/docs/5.0/assets/img/examples/blog-rtl@2x.png create mode 100644 site/static/docs/5.0/assets/img/examples/carousel-rtl.png create mode 100644 site/static/docs/5.0/assets/img/examples/carousel-rtl@2x.png create mode 100644 site/static/docs/5.0/assets/img/examples/cheatsheet-rtl.png create mode 100644 site/static/docs/5.0/assets/img/examples/cheatsheet-rtl@2x.png create mode 100644 site/static/docs/5.0/assets/img/examples/cheatsheet.png create mode 100644 site/static/docs/5.0/assets/img/examples/cheatsheet@2x.png create mode 100644 site/static/docs/5.0/assets/img/examples/checkout-rtl.png create mode 100644 site/static/docs/5.0/assets/img/examples/checkout-rtl@2x.png create mode 100644 site/static/docs/5.0/assets/img/examples/dashboard-rtl.png create mode 100644 site/static/docs/5.0/assets/img/examples/dashboard-rtl@2x.png diff --git a/README.md b/README.md index 1e8edf958c..b89ccc55d0 100644 --- a/README.md +++ b/README.md @@ -83,37 +83,52 @@ Within the download you'll find the following directories and files, logically g ```text bootstrap/ -└── dist/ - ├── 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-utilities.css - │ ├── bootstrap-utilities.css.map - │ ├── bootstrap-utilities.min.css - │ ├── bootstrap-utilities.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 +├── 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 ``` 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/). diff --git a/config.yml b/config.yml index 72776be7d9..c11ba26cae 100644 --- a/config.yml +++ b/config.yml @@ -69,6 +69,8 @@ params: # See https://www.srihash.org for info on how to generate the hashes css: "https://cdn.jsdelivr.net/npm/bootstrap@5.0.0-alpha3/dist/css/bootstrap.min.css" css_hash: "sha384-CuOF+2SnTUfTwSZjCXf01h7uYhfOBuxIhGKPbfEJ3+FqH/s6cIFN9bGr1HmAg4fQ" + css_rtl: "https://cdn.jsdelivr.net/npm/bootstrap@5.0.0-alpha3/dist/css/bootstrap.rtl.min.css" + css_rtl_hash: "sha384-uj/jH1CKdoyy7O7FcQiip/ZwNPeeCKD6gmJYIPb6MaRisjidXKT95KwcjQNGFuFS" js: "https://cdn.jsdelivr.net/npm/bootstrap@5.0.0-alpha3/dist/js/bootstrap.min.js" js_hash: "sha384-t6I8D5dJmMXjCsRLhSzCltuhNZg6P10kE0m0nAncLUjH6GeYLhRU1zfLoW3QNQDF" js_bundle: "https://cdn.jsdelivr.net/npm/bootstrap@5.0.0-alpha3/dist/js/bootstrap.bundle.min.js" diff --git a/site/content/docs/5.0/about/team.md b/site/content/docs/5.0/about/team.md index fd1d6bfa6b..3c1666f29d 100644 --- a/site/content/docs/5.0/about/team.md +++ b/site/content/docs/5.0/about/team.md @@ -11,7 +11,7 @@ Bootstrap is maintained by the founding team and a small group of invaluable cor
{{- range (index $.Site.Data "core-team") }} - @{{ .user }} + @{{ .user }} {{ .name }} @{{ .user }} diff --git a/site/content/docs/5.0/components/breadcrumb.md b/site/content/docs/5.0/components/breadcrumb.md index 893f1f0092..3395fbf67d 100644 --- a/site/content/docs/5.0/components/breadcrumb.md +++ b/site/content/docs/5.0/components/breadcrumb.md @@ -35,7 +35,7 @@ Use an ordered or unordered list with linked list items to create a minimally st ## Dividers -Dividers are automatically added in CSS through [`::before`](https://developer.mozilla.org/en-US/docs/Web/CSS/::before) and [`content`](https://developer.mozilla.org/en-US/docs/Web/CSS/content). They can be changed by modifying a local CSS custom property `--bs-breadcrumb-divider`, or through the `$breadcrumb-divider` Sass variable. We default to our Sass variable, which is set as a fallback to the custom property. This way, you get a global divider that you can override without recompiling CSS at any time. +Dividers are automatically added in CSS through [`::before`](https://developer.mozilla.org/en-US/docs/Web/CSS/::before) and [`content`](https://developer.mozilla.org/en-US/docs/Web/CSS/content). They can be changed by modifying a local CSS custom property `--bs-breadcrumb-divider`, or through the `$breadcrumb-divider` Sass variable — and `$breadcrumb-divider-flipped` for its RTL counterpart, if needed. We default to our Sass variable, which is set as a fallback to the custom property. This way, you get a global divider that you can override without recompiling CSS at any time. {{< example >}} {{< /example >}} -This example uses [color]({{< docsref "/utilities/colors" >}}) (`bg-light`) and [spacing]({{< docsref "/utilities/spacing" >}}) (`my-2`, `my-lg-0`, `mr-sm-0`, `my-sm-0`) utility classes. +This example uses [color]({{< docsref "/utilities/colors" >}}) (`bg-light`) and [spacing]({{< docsref "/utilities/spacing" >}}) (`my-2`, `my-lg-0`, `me-sm-0`, `my-sm-0`) utility classes. ### Brand @@ -220,7 +220,7 @@ Place various form controls and components within a navbar: @@ -149,14 +149,14 @@ Scrollspy also works with nested `.nav`s. If a nested `.nav` is `.active`, its p diff --git a/site/content/docs/5.0/components/spinners.md b/site/content/docs/5.0/components/spinners.md index 250e334b83..d2495b4206 100644 --- a/site/content/docs/5.0/components/spinners.md +++ b/site/content/docs/5.0/components/spinners.md @@ -97,7 +97,7 @@ Use [flexbox utilities][flex], [float utilities][float], or [text alignment][tex {{< example >}}
Loading... - +
{{< /example >}} @@ -105,7 +105,7 @@ Use [flexbox utilities][flex], [float utilities][float], or [text alignment][tex {{< example >}}
- diff --git a/site/content/docs/5.0/components/toasts.md b/site/content/docs/5.0/components/toasts.md index 48c68b60be..be368c76e4 100644 --- a/site/content/docs/5.0/components/toasts.md +++ b/site/content/docs/5.0/components/toasts.md @@ -31,8 +31,8 @@ Toasts are as flexible as you need and have very little required markup. At a mi {{< example class="bg-light" >}}