From d17fe26dcfe371a3e78fabb4d34e6ba6e2c38a67 Mon Sep 17 00:00:00 2001
From: Mark Otto
Date: Sun, 22 May 2022 17:47:01 -0700
Subject: [PATCH] Rewrite Parcel guide (#36411)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
* Rewrite Parcel guide
* update to match latest webpack guide, add images
* eslint-skip
* Apply suggestions from code review
Co-authored-by: Julien Déramond
* match parcel to webpack, share footer, consistent use of no ;
* Update site/content/docs/5.2/getting-started/parcel.md
Co-authored-by: Julien Déramond
* edits from code review
* Add custom images
* add image compression action from blog
Co-authored-by: Julien Déramond
---
.../workflows/calibreapp-image-actions.yml | 24 +++
site/content/docs/5.2/customize/sass.md | 2 +-
.../docs/5.2/getting-started/parcel.md | 187 ++++++++++++------
.../docs/5.2/getting-started/webpack.md | 19 +-
site/layouts/partials/guide-footer.md | 3 +
.../assets/img/guides/bootstrap-parcel.png | Bin 0 -> 162121 bytes
.../assets/img/guides/bootstrap-parcel@2x.png | Bin 0 -> 566553 bytes
.../assets/img/guides/bootstrap-webpack.png | Bin 0 -> 170257 bytes
.../img/guides/bootstrap-webpack@2x.png | Bin 0 -> 573736 bytes
.../guides/parcel-dev-server-bootstrap.png | Bin 0 -> 165346 bytes
.../assets/img/guides/parcel-dev-server.png | Bin 0 -> 128524 bytes
11 files changed, 159 insertions(+), 76 deletions(-)
create mode 100644 .github/workflows/calibreapp-image-actions.yml
create mode 100644 site/layouts/partials/guide-footer.md
create mode 100644 site/static/docs/5.2/assets/img/guides/bootstrap-parcel.png
create mode 100644 site/static/docs/5.2/assets/img/guides/bootstrap-parcel@2x.png
create mode 100644 site/static/docs/5.2/assets/img/guides/bootstrap-webpack.png
create mode 100644 site/static/docs/5.2/assets/img/guides/bootstrap-webpack@2x.png
create mode 100644 site/static/docs/5.2/assets/img/guides/parcel-dev-server-bootstrap.png
create mode 100644 site/static/docs/5.2/assets/img/guides/parcel-dev-server.png
diff --git a/.github/workflows/calibreapp-image-actions.yml b/.github/workflows/calibreapp-image-actions.yml
new file mode 100644
index 0000000000..e23f5626e4
--- /dev/null
+++ b/.github/workflows/calibreapp-image-actions.yml
@@ -0,0 +1,24 @@
+name: Compress Images
+
+on:
+ pull_request:
+ paths:
+ - '**.jpg'
+ - '**.jpeg'
+ - '**.png'
+ - '**.webp'
+
+jobs:
+ build:
+ # Only run on Pull Requests within the same repository, and not from forks.
+ if: github.event.pull_request.head.repo.full_name == github.repository
+ name: calibreapp/image-actions
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout Repo
+ uses: actions/checkout@v3
+
+ - name: Compress Images
+ uses: calibreapp/image-actions@1.1.0
+ with:
+ githubToken: ${{ secrets.GITHUB_TOKEN }}
diff --git a/site/content/docs/5.2/customize/sass.md b/site/content/docs/5.2/customize/sass.md
index 0be56db9b4..a80004e1bb 100644
--- a/site/content/docs/5.2/customize/sass.md
+++ b/site/content/docs/5.2/customize/sass.md
@@ -22,7 +22,7 @@ your-project/
└── scss
```
-If you've downloaded our source files and aren't using a package manager, you'll want to manually setup something similar to that structure, keeping Bootstrap's source files separate from your own.
+If you've downloaded our source files and aren't using a package manager, you'll want to manually create something similar to that structure, keeping Bootstrap's source files separate from your own.
```text
your-project/
diff --git a/site/content/docs/5.2/getting-started/parcel.md b/site/content/docs/5.2/getting-started/parcel.md
index c25fb644a8..9b93eef9ce 100644
--- a/site/content/docs/5.2/getting-started/parcel.md
+++ b/site/content/docs/5.2/getting-started/parcel.md
@@ -1,101 +1,158 @@
---
layout: docs
-title: Parcel
-description: Learn how to include Bootstrap in your project using Parcel.
+title: "Bootstrap & Parcel"
+description: The official guide for how to include and bundle Bootstrap's CSS and JavaScript in your project using Parcel.
group: getting-started
toc: true
---
-## Install Parcel
+
-Install [Parcel Bundler](https://parceljs.org/getting-started/webapp/).
+{{< 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/parcel). You can also [open the example in StackBlitz](https://stackblitz.com/github/twbs/examples/tree/main/parcel?file=index.html) but not run it because Parcel isn't currently supported there.
+{{< /callout >}}
-## Install Bootstrap
+## Setup
-[Install bootstrap]({{< docsref "/getting-started/download#npm" >}}) as a Node.js module using npm.
+We're building a Parcel 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.
-Bootstrap depends on [Popper](https://popper.js.org/), which is specified in the `peerDependencies` property. This means that you will have to make sure to add both of them to your `package.json` using `npm install @popperjs/core`.
+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.
-When all will be completed, your project will be structured like this:
+ ```sh
+ mkdir my-project && cd my-project
+ npm init -y
+ ```
+
+2. **Install Parcel.** Unlike our Webpack guide, there's only a single build tool dependency here. Parcel will automatically install language transformers (like Sass) as it detects them. We use `--save-dev` to signal that this dependency is only for development use and not for production.
+
+ ```sh
+ npm i --save-dev parcel
+ ```
+
+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
+ ```
+
+Now that we have all the necessary dependencies installed, 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
+```
+
+When you're done, your complete project should look like this:
```text
-project-name/
-├── build/
-├── node_modules/
-│ ├── @popperjs/
-| | └── core/
-│ └── bootstrap/
-├── scss/
-│ └── custom.scss
+my-project/
├── src/
-│ ├── index.html
-│ └── index.js
+│ ├── js/
+│ │ └── main.js
+│ ├── scss/
+│ │ └── styles.scss
+│ └── index.html
+├── package-lock.json
└── package.json
```
-## Importing JavaScript
+At this point, everything is in the right place, but Parcel needs an HTML page and npm script to start our server.
-Import [Bootstrap's JavaScript]({{< docsref "/getting-started/javascript" >}}) in your app's entry point (usually `src/index.js`). You can import all our plugins in one file or separately if you require only a subset of them.
+## Configure Parcel
-
-```js
-// Import all plugins
-import * as bootstrap from 'bootstrap';
+With dependencies installed and our project folder ready for us to start coding, we can now configure Parcel and run our project locally. Parcel itself requires no configuration file by design, but we do need an npm script and an HTML file to start our server.
-// Or import only needed plugins
-import { Tooltip as Tooltip, Toast as Toast, Popover as Popover } from 'bootstrap';
+1. **Fill in the `src/index.html` file.** Parcel needs a page to render, so we use our `index.html` page to setup some basic HTML, including our CSS and JavaScript files.
-// Or import just one
-import Alert as Alert from '../node_modules/bootstrap/js/dist/alert';
-```
+ ```html
+
+
+
+
+
+ Bootstrap w/ Parcel
+
+
+
+
+
+
Hello, Bootstrap and Parcel!
+
+
+
+
+ ```
-## Importing CSS
+ We're including a little bit of Bootstrap styling here with the `div class="container"` and `
` tag.
+3. **And finally, we can start Parcel.** From the `my-project` folder in your terminal, run that newly added npm script:
-```html
-
-
- -
-
-
-
-Install [Parcel Bundler](https://parceljs.org/getting-started/webapp/).
+{{< 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/parcel). You can also [open the example in StackBlitz](https://stackblitz.com/github/twbs/examples/tree/main/parcel?file=index.html) but not run it because Parcel isn't currently supported there.
+{{< /callout >}}
-## Install Bootstrap
+## Setup
-[Install bootstrap]({{< docsref "/getting-started/download#npm" >}}) as a Node.js module using npm.
+We're building a Parcel 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.
-Bootstrap depends on [Popper](https://popper.js.org/), which is specified in the `peerDependencies` property. This means that you will have to make sure to add both of them to your `package.json` using `npm install @popperjs/core`.
+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.
-When all will be completed, your project will be structured like this:
+ ```sh
+ mkdir my-project && cd my-project
+ npm init -y
+ ```
+
+2. **Install Parcel.** Unlike our Webpack guide, there's only a single build tool dependency here. Parcel will automatically install language transformers (like Sass) as it detects them. We use `--save-dev` to signal that this dependency is only for development use and not for production.
+
+ ```sh
+ npm i --save-dev parcel
+ ```
+
+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
+ ```
+
+Now that we have all the necessary dependencies installed, 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
+```
+
+When you're done, your complete project should look like this:
```text
-project-name/
-├── build/
-├── node_modules/
-│ ├── @popperjs/
-| | └── core/
-│ └── bootstrap/
-├── scss/
-│ └── custom.scss
+my-project/
├── src/
-│ ├── index.html
-│ └── index.js
+│ ├── js/
+│ │ └── main.js
+│ ├── scss/
+│ │ └── styles.scss
+│ └── index.html
+├── package-lock.json
└── package.json
```
-## Importing JavaScript
+At this point, everything is in the right place, but Parcel needs an HTML page and npm script to start our server.
-Import [Bootstrap's JavaScript]({{< docsref "/getting-started/javascript" >}}) in your app's entry point (usually `src/index.js`). You can import all our plugins in one file or separately if you require only a subset of them.
+## Configure Parcel
-
-```js
-// Import all plugins
-import * as bootstrap from 'bootstrap';
+With dependencies installed and our project folder ready for us to start coding, we can now configure Parcel and run our project locally. Parcel itself requires no configuration file by design, but we do need an npm script and an HTML file to start our server.
-// Or import only needed plugins
-import { Tooltip as Tooltip, Toast as Toast, Popover as Popover } from 'bootstrap';
+1. **Fill in the `src/index.html` file.** Parcel needs a page to render, so we use our `index.html` page to setup some basic HTML, including our CSS and JavaScript files.
-// Or import just one
-import Alert as Alert from '../node_modules/bootstrap/js/dist/alert';
-```
+ ```html
+
+
+
+
+
+