From 5b0bf3f49a94ca96334651eca9aeeb56d48bf144 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20D=C3=A9ramond?= Date: Sat, 4 Jun 2022 18:42:32 +0200 Subject: [PATCH 1/2] Docs: Add a Vite Getting Started guide (#36412) * Docs: Add a Vite Getting Started guide * Fix npm run docs temporarily * Fix cspell and lint * Uncomment the 2nd part * . * Make it work without dist * Updates after merges of Parcel/Webpack guides rewriting * Update images * Replace dev images * Compress the new images better * Update site/content/docs/5.2/customize/optimize.md Co-authored-by: Mark Otto * Update site/content/docs/5.2/getting-started/vite.md Co-authored-by: Mark Otto Co-authored-by: XhmikosR Co-authored-by: Mark Otto --- .cspell.json | 1 + site/content/docs/5.2/customize/optimize.md | 2 +- .../5.2/examples/starter-template/index.html | 1 + .../docs/5.2/getting-started/javascript.md | 2 +- site/content/docs/5.2/getting-started/vite.md | 197 ++++++++++++++++++ .../docs/5.2/getting-started/webpack.md | 4 +- site/data/sidebar.yml | 1 + site/layouts/partials/footer.html | 1 + .../5.2/assets/img/guides/bootstrap-vite.png | Bin 0 -> 169189 bytes .../assets/img/guides/bootstrap-vite@2x.png | Bin 0 -> 558538 bytes .../img/guides/vite-dev-server-bootstrap.png | Bin 0 -> 75894 bytes .../5.2/assets/img/guides/vite-dev-server.png | Bin 0 -> 74851 bytes 12 files changed, 205 insertions(+), 4 deletions(-) create mode 100644 site/content/docs/5.2/getting-started/vite.md create mode 100644 site/static/docs/5.2/assets/img/guides/bootstrap-vite.png create mode 100644 site/static/docs/5.2/assets/img/guides/bootstrap-vite@2x.png create mode 100644 site/static/docs/5.2/assets/img/guides/vite-dev-server-bootstrap.png create mode 100644 site/static/docs/5.2/assets/img/guides/vite-dev-server.png diff --git a/.cspell.json b/.cspell.json index 11516df2dc9a..315a89979bd7 100644 --- a/.cspell.json +++ b/.cspell.json @@ -108,6 +108,7 @@ "urlize", "vbtn", "viewports", + "Vite", "vstack", "walkthroughs", "WCAG", diff --git a/site/content/docs/5.2/customize/optimize.md b/site/content/docs/5.2/customize/optimize.md index b5e8de7ee2a2..8574f3650af8 100644 --- a/site/content/docs/5.2/customize/optimize.md +++ b/site/content/docs/5.2/customize/optimize.md @@ -19,7 +19,7 @@ If you're not using a component, comment it out or delete it entirely. For examp Bootstrap's JavaScript includes every component in our primary dist files (`bootstrap.js` and `bootstrap.min.js`), and even our primary dependency (Popper) with our bundle files (`bootstrap.bundle.js` and `bootstrap.bundle.min.js`). While you're customizing via Sass, be sure to remove related JavaScript. -For instance, assuming you're using your own JavaScript bundler like Webpack or Rollup, you'd only import the JavaScript you plan on using. In the example below, we show how to just include our modal JavaScript: +For instance, assuming you're using your own JavaScript bundler like Webpack, Parcel, or Vite, you'd only import the JavaScript you plan on using. In the example below, we show how to just include our modal JavaScript: ```js diff --git a/site/content/docs/5.2/examples/starter-template/index.html b/site/content/docs/5.2/examples/starter-template/index.html index e1eda9e304cb..a16984ab9b57 100644 --- a/site/content/docs/5.2/examples/starter-template/index.html +++ b/site/content/docs/5.2/examples/starter-template/index.html @@ -40,6 +40,7 @@

Guides

  • }}">Bootstrap quick start guide
  • }}">Bootstrap Webpack guide
  • }}">Bootstrap Parcel guide
    • +
  • }}">Bootstrap Vite guide
  • }}">Contributing to Bootstrap
    • diff --git a/site/content/docs/5.2/getting-started/javascript.md b/site/content/docs/5.2/getting-started/javascript.md index 3f8d2c5cb8df..6badaab7ad63 100644 --- a/site/content/docs/5.2/getting-started/javascript.md +++ b/site/content/docs/5.2/getting-started/javascript.md @@ -10,7 +10,7 @@ toc: true Plugins can be included individually (using Bootstrap's individual `js/dist/*.js`), or all at once using `bootstrap.js` or the minified `bootstrap.min.js` (don't include both). -If you use a bundler (Webpack, Rollup...), you can use `/js/dist/*.js` files which are UMD ready. +If you use a bundler (Webpack, Parcel, Vite...), you can use `/js/dist/*.js` files which are UMD ready. ## Usage with JavaScript frameworks diff --git a/site/content/docs/5.2/getting-started/vite.md b/site/content/docs/5.2/getting-started/vite.md new file mode 100644 index 000000000000..ca0b61925ec6 --- /dev/null +++ b/site/content/docs/5.2/getting-started/vite.md @@ -0,0 +1,197 @@ +--- +layout: docs +title: "Bootstrap & Vite" +description: The official guide for how to include and bundle Bootstrap's CSS and JavaScript in your project using Vite. +group: getting-started +toc: true +--- + + + +{{< callout >}} +**Want to skip to the end?** Download the source code and working demo for this guide from the [twbs/examples repository](https://github.com/twbs/examples/tree/main/vite). You can also [open the example in StackBlitz](https://stackblitz.com/github/twbs/examples/tree/main/vite?file=index.html) for live editing. +{{< /callout >}} + +## Setup + +We're building a Vite project with Bootstrap from scratch, so there are some prerequisites and up front steps before we can really get started. This guide requires you to have Node.js installed and some familiarity with the terminal. + +1. **Create a project folder and setup npm.** We'll create the `my-project` folder and initialize npm with the `-y` argument to avoid it asking us all the interactive questions. + + ```sh + mkdir my-project && cd my-project + npm init -y + ``` + +2. **Install Vite.** Unlike our Webpack guide, there’s only a single build tool dependency here. We use `--save-dev` to signal that this dependency is only for development use and not for production. + + ```sh + npm i --save-dev vite + ``` + +3. **Install Bootstrap.** Now we can install Bootstrap. We'll also install Popper since our dropdowns, popovers, and tooltips depend on it for their positioning. If you don't plan on using those components, you can omit Popper here. + + ```sh + npm i --save bootstrap @popperjs/core + ``` +4. **Install additional dependency.** In addition to Vite and Bootstrap, we need another dependency (Sass) to properly import and bundle Bootstrap's CSS. + + ```sh + npm i --save-dev sass + ``` + +Now that we have all the necessary dependencies installed and setup, we can get to work creating the project files and importing Bootstrap. + +## Project structure + +We've already created the `my-project` folder and initialized npm. Now we'll also create our `src` folder, stylesheet, and JavaScript file to round out the project structure. Run the following from `my-project`, or manually create the folder and file structure shown below. + +```sh +mkdir {src,src/js,src/scss} +touch src/index.html src/js/main.js src/scss/styles.scss vite.config.js +``` + +When you're done, your complete project should look like this: + +```text +my-project/ +├── src/ +│ ├── js/ +│ │ └── main.js +│ └── scss/ +│ | └── styles.scss +| └── index.html +├── package-lock.json +├── package.json +└── vite.config.js +``` + +At this point, everything is in the right place, but Vite won't work because we haven't filled in our `vite.config.js` yet. + +## Configure Vite + +With dependencies installed and our project folder ready for us to start coding, we can now configure Vite and run our project locally. + +1. **Open `vite.config.js` in your editor.** Since it's blank, we'll need to add some boilerplate config to it so we can start our server. This part of the config tells Vite were to look for our project's JavaScript and how the development server should behave (pulling from the `src` folder with hot reload). + + + ```js + const path = require('path') + + export default { + root: path.resolve(__dirname, 'src'), + server: { + port: 8080, + hot: true + } + } + ``` + +2. **Next we fill in `src/index.html`.** This is the HTML page Vite will load in the browser to utilize the bundled CSS and JS we'll add to it in later steps. + + ```html + + + + + + Bootstrap w/ Vite + + +
    +

    Hello, Bootstrap and Vite!

    + +
    + + + + ``` + + We're including a little bit of Bootstrap styling here with the `div class="container"` and ` -