Skip to content

Commit e2df145

Browse files
committed
v6: Move some Getting Started content into new Guides section (#41797)
* Move some docs content around * Update links
1 parent f3a5926 commit e2df145

File tree

12 files changed

+26
-18
lines changed

12 files changed

+26
-18
lines changed

site/data/sidebar.yml

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,17 @@
1010
- title: Contents
1111
- title: Browsers & devices
1212
- title: JavaScript
13-
- title: Webpack
14-
- title: Parcel
15-
- title: Vite
1613
- title: Accessibility
1714
- title: RFS
1815
- title: RTL
16+
17+
- title: Guides
18+
icon: map
19+
icon_color: green
20+
pages:
21+
- title: Webpack
22+
- title: Parcel
23+
- title: Vite
1924
- title: Contribute
2025

2126
- title: Customize

site/src/assets/examples/starter-template/index.astro

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -75,25 +75,25 @@ export const title = 'Starter Template'
7575
</a>
7676
</li>
7777
<li>
78-
<a class="icon-link mb-1" href={getVersionedDocsPath('/getting-started/webpack')}>
78+
<a class="icon-link mb-1" href={getVersionedDocsPath('/guides/webpack')}>
7979
<svg class="bi" width="16" height="16" aria-hidden="true"><use xlink:href="#arrow-right-circle"/></svg>
8080
Bootstrap Webpack guide
8181
</a>
8282
</li>
8383
<li>
84-
<a class="icon-link mb-1" href={getVersionedDocsPath('/getting-started/parcel')}>
84+
<a class="icon-link mb-1" href={getVersionedDocsPath('/guides/parcel')}>
8585
<svg class="bi" width="16" height="16" aria-hidden="true"><use xlink:href="#arrow-right-circle"/></svg>
8686
Bootstrap Parcel guide
8787
</a>
8888
</li>
8989
<li>
90-
<a class="icon-link mb-1" href={getVersionedDocsPath('/getting-started/vite')}>
90+
<a class="icon-link mb-1" href={getVersionedDocsPath('/guides/vite')}>
9191
<svg class="bi" width="16" height="16" aria-hidden="true"><use xlink:href="#arrow-right-circle"/></svg>
9292
Bootstrap Vite guide
9393
</a>
9494
</li>
9595
<li>
96-
<a class="icon-link mb-1" href={getVersionedDocsPath('/getting-started/contribute')}>
96+
<a class="icon-link mb-1" href={getVersionedDocsPath('/guides/contribute')}>
9797
<svg class="bi" width="16" height="16" aria-hidden="true"><use xlink:href="#arrow-right-circle"/></svg>
9898
Contributing to Bootstrap
9999
</a>

site/src/components/footer/Footer.astro

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,9 @@ import { getVersionedDocsPath } from '@libs/path'
4848
<ul class="list-unstyled">
4949
<li class="mb-2"><a href={getVersionedDocsPath('getting-started')}>Getting started</a></li>
5050
<li class="mb-2"><a href={getVersionedDocsPath('examples/starter-template')}>Starter template</a></li>
51-
<li class="mb-2"><a href={getVersionedDocsPath('getting-started/webpack')}>Webpack</a></li>
52-
<li class="mb-2"><a href={getVersionedDocsPath('getting-started/parcel')}>Parcel</a></li>
53-
<li class="mb-2"><a href={getVersionedDocsPath('getting-started/vite')}>Vite</a></li>
51+
<li class="mb-2"><a href={getVersionedDocsPath('guides/webpack')}>Webpack</a></li>
52+
<li class="mb-2"><a href={getVersionedDocsPath('guides/parcel')}>Parcel</a></li>
53+
<li class="mb-2"><a href={getVersionedDocsPath('guides/vite')}>Vite</a></li>
5454
</ul>
5555
</div>
5656
<div class="col-6 col-lg-2 mb-3">

site/src/components/home/GetStarted.astro

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ import Code from '@shortcodes/Code.astro'
7070
<div class="d-flex flex-wrap align-items-center justify-content-center gap-4 mt-4">
7171
<a
7272
class="d-flex flex-column align-items-center text-decoration-none animate-img"
73-
href={getVersionedDocsPath('getting-started/webpack/')}
73+
href={getVersionedDocsPath('guides/webpack/')}
7474
>
7575
<img
7676
class="d-block mb-2"
@@ -84,7 +84,7 @@ import Code from '@shortcodes/Code.astro'
8484
</a>
8585
<a
8686
class="d-flex flex-column align-items-center text-decoration-none animate-img"
87-
href={getVersionedDocsPath('getting-started/parcel/')}
87+
href={getVersionedDocsPath('guides/parcel/')}
8888
>
8989
<img
9090
class="d-block mb-2"
@@ -98,7 +98,7 @@ import Code from '@shortcodes/Code.astro'
9898
</a>
9999
<a
100100
class="d-flex flex-column align-items-center text-decoration-none animate-img"
101-
href={getVersionedDocsPath('getting-started/vite/')}
101+
href={getVersionedDocsPath('guides/vite/')}
102102
>
103103
<img
104104
class="d-block mb-2"

site/src/components/icons/Symbols.astro

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,9 @@
9696
d="M9.5 2.672a.5.5 0 1 0 1 0V.843a.5.5 0 0 0-1 0v1.829Zm4.5.035A.5.5 0 0 0 13.293 2L12 3.293a.5.5 0 1 0 .707.707L14 2.707ZM7.293 4A.5.5 0 1 0 8 3.293L6.707 2A.5.5 0 0 0 6 2.707L7.293 4Zm-.621 2.5a.5.5 0 1 0 0-1H4.843a.5.5 0 1 0 0 1h1.829Zm8.485 0a.5.5 0 1 0 0-1h-1.829a.5.5 0 0 0 0 1h1.829ZM13.293 10A.5.5 0 1 0 14 9.293L12.707 8a.5.5 0 1 0-.707.707L13.293 10ZM9.5 11.157a.5.5 0 0 0 1 0V9.328a.5.5 0 0 0-1 0v1.829Zm1.854-5.097a.5.5 0 0 0 0-.706l-.708-.708a.5.5 0 0 0-.707 0L8.646 5.94a.5.5 0 0 0 0 .707l.708.708a.5.5 0 0 0 .707 0l1.293-1.293Zm-3 3a.5.5 0 0 0 0-.706l-.708-.708a.5.5 0 0 0-.707 0L.646 13.94a.5.5 0 0 0 0 .707l.708.708a.5.5 0 0 0 .707 0L8.354 9.06Z"
9797
></path>
9898
</symbol>
99+
<symbol id="map" viewBox="0 0 16 16">
100+
<path fill-rule="evenodd" d="M15.817.113A.5.5 0 0 1 16 .5v14a.5.5 0 0 1-.402.49l-5 1a.5.5 0 0 1-.196 0L5.5 15.01l-4.902.98A.5.5 0 0 1 0 15.5v-14a.5.5 0 0 1 .402-.49l5-1a.5.5 0 0 1 .196 0L10.5.99l4.902-.98a.5.5 0 0 1 .415.103M10 1.91l-4-.8v12.98l4 .8zm1 12.98 4-.8V1.11l-4 .8zm-6-.8V1.11l-4 .8v12.98z"/>
101+
</symbol>
99102
<symbol id="menu-button-wide-fill" viewBox="0 0 16 16">
100103
<path
101104
d="M1.5 0A1.5 1.5 0 0 0 0 1.5v2A1.5 1.5 0 0 0 1.5 5h13A1.5 1.5 0 0 0 16 3.5v-2A1.5 1.5 0 0 0 14.5 0h-13zm1 2h3a.5.5 0 0 1 0 1h-3a.5.5 0 0 1 0-1zm9.927.427A.25.25 0 0 1 12.604 2h.792a.25.25 0 0 1 .177.427l-.396.396a.25.25 0 0 1-.354 0l-.396-.396zM0 8a2 2 0 0 1 2-2h12a2 2 0 0 1 2 2v5a2 2 0 0 1-2 2H2a2 2 0 0 1-2-2V8zm1 3v2a1 1 0 0 0 1 1h12a1 1 0 0 0 1-1v-2H1zm14-1V8a1 1 0 0 0-1-1H2a1 1 0 0 0-1 1v2h14zM2 8.5a.5.5 0 0 1 .5-.5h9a.5.5 0 0 1 0 1h-9a.5.5 0 0 1-.5-.5zm0 4a.5.5 0 0 1 .5-.5h6a.5.5 0 0 1 0 1h-6a.5.5 0 0 1-.5-.5z"

site/src/content/docs/customize/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,4 +59,4 @@ Several Bootstrap components include embedded SVGs in our CSS to style component
5959
- [Form validation icons]([[docsref:/forms/validation#server-side]])
6060
- [Navbar toggle buttons]([[docsref:/components/navbar#responsive-behaviors]])
6161

62-
Based on [community conversation](https://github.com/twbs/bootstrap/issues/25394), some options for addressing this in your own codebase include [replacing the URLs with locally hosted assets]([[docsref:/getting-started/webpack#extracting-svg-files]]), removing the images and using inline images (not possible in all components), and modifying your CSP. Our recommendation is to carefully review your own security policies and decide on the best path forward, if necessary.
62+
Based on [community conversation](https://github.com/twbs/bootstrap/issues/25394), some options for addressing this in your own codebase include [replacing the URLs with locally hosted assets]([[docsref:/guides/webpack#extracting-svg-files]]), removing the images and using inline images (not possible in all components), and modifying your CSP. Our recommendation is to carefully review your own security policies and decide on the best path forward, if necessary.

site/src/content/docs/customize/sass.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ sass --watch ./scss/custom.scss ./css/custom.css
107107
Learn more about your options at [sass-lang.com/install](https://sass-lang.com/install/) and [compiling with VS Code](https://code.visualstudio.com/docs/languages/css#_transpiling-sass-and-less-into-css).
108108

109109
<Callout>
110-
**Using Bootstrap with another build tool?** Consider reading our guides for compiling with [Webpack]([[docsref:/getting-started/webpack]]), [Parcel]([[docsref:/getting-started/parcel]]), or [Vite]([[docsref:/getting-started/vite]]). We also have production-ready demos in [our examples repository on GitHub](https://github.com/twbs/examples).
110+
**Using Bootstrap with another build tool?** Consider reading our guides for compiling with [Webpack]([[docsref:/guides/webpack]]), [Parcel]([[docsref:/guides/parcel]]), or [Vite]([[docsref:/guides/vite]]). We also have production-ready demos in [our examples repository on GitHub](https://github.com/twbs/examples).
111111
</Callout>
112112

113113
## Including

site/src/content/docs/getting-started/download.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ This doesn’t include documentation, source files, or any optional JavaScript d
1919

2020
Compile Bootstrap with your own asset pipeline by downloading our source Sass, JavaScript, and documentation files. This option requires some additional tooling:
2121

22-
- [Sass compiler]([[docsref:/getting-started/contribute#sass]]) for compiling Sass source files into CSS files
22+
- [Sass compiler]([[docsref:/guides/contribute#sass]]) for compiling Sass source files into CSS files
2323
- [Autoprefixer](https://github.com/postcss/autoprefixer) for CSS vendor prefixing
2424

25-
Should you require our full set of [build tools]([[docsref:/getting-started/contribute#tooling-setup]]), they are included for developing Bootstrap and its docs, but they’re likely unsuitable for your own purposes.
25+
Should you require our full set of [build tools]([[docsref:/guides/contribute#tooling-setup]]), they are included for developing Bootstrap and its docs, but they’re likely unsuitable for your own purposes.
2626

2727
<a href="[[config:download.source]]" class="btn btn-bd-primary">Download source</a>
2828

@@ -68,7 +68,7 @@ openssl dgst -sha384 -binary bootstrap.min.js | openssl base64 -A
6868

6969
## Package managers
7070

71-
Pull in Bootstrap’s **source files** into nearly any project with some of the most popular package managers. No matter the package manager, Bootstrap will **require a [Sass compiler]([[docsref:/getting-started/contribute#sass]]) and [Autoprefixer](https://github.com/postcss/autoprefixer)** for a setup that matches our official compiled versions.
71+
Pull in Bootstrap’s **source files** into nearly any project with some of the most popular package managers. No matter the package manager, Bootstrap will **require a [Sass compiler]([[docsref:/guides/contribute#sass]]) and [Autoprefixer](https://github.com/postcss/autoprefixer)** for a setup that matches our official compiled versions.
7272

7373
### npm
7474

File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)