docs(migration): add section for html asset sources (#18536)

vitejs · Oct 31, 2024 · f65d6ae · f65d6ae
1 parent 8a7af50
commit f65d6ae
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/docs/guide/features.md b/docs/guide/features.md
@@ -170,7 +170,7 @@ Any HTML files in your project root can be directly accessed by its respective d
 - `<root>/about.html` -> `http://localhost:5173/about.html`
 - `<root>/blog/index.html` -> `http://localhost:5173/blog/index.html`
 
-Files referenced by HTML elements such as `<script type="module">` and `<link href>` are processed and bundled as part of the app. General asset elements can also reference assets to be optimized by default, including:
+Assets referenced by HTML elements such as `<script type="module" src>` and `<link href>` are processed and bundled as part of the app. The full list of supported elements are as below:
 
 - `<audio src>`
 - `<embed src>`
@@ -179,6 +179,7 @@ Files referenced by HTML elements such as `<script type="module">` and `<link hr
 - `<input src>`
 - `<link href>` and `<link imagesrcet>`
 - `<object data>`
+- `<script type="module" src>`
 - `<source src>` and `<source srcset>`
 - `<track src>`
 - `<use href>` and `<use xlink:href>`

diff --git a/docs/guide/migration.md b/docs/guide/migration.md
@@ -20,6 +20,14 @@ From Vite 6, even when `json.stringify: true` is set, `json.namedExports` is not
 
 Vite 6 also introduces a new default value for `json.stringify` which is `'auto'`, which will only stringify large JSON files. To disable this behavior, set `json.stringify: false`.
 
+### Extended support of asset references in HTML elements
+
+In Vite 5, only a few supported HTML elements were able to reference assets that will be processed and bundled by Vite, such as `<link href>`, `<img src>`, etc.
+
+Vite 6 extends the support to even more HTML elements. The full list can be found at the [HTML features](/guide/features.html#html) docs.
+
+To opt-out of HTML processing on certain elements, you can add the `vite-ignore` attribute on the element.
+
 ### postcss-load-config
 
 [`postcss-load-config`](https://npmjs.com/package/postcss-load-config) has been updated to v6 from v4. [`tsx`](https://www.npmjs.com/package/tsx) or [`jiti`](https://www.npmjs.com/package/jiti) is now required to load TypeScript postcss config files instead of [`ts-node`](https://www.npmjs.com/package/ts-node). Also [`yaml`](https://www.npmjs.com/package/yaml) is now required to load YAML postcss config files.