docs: transformIndexHtml order note (#13318)

vitejs · May 24, 2023 · 57d3023 · 57d3023
1 parent e3db771
commit 57d3023
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/docs/guide/api-plugin.md b/docs/guide/api-plugin.md
@@ -345,6 +345,8 @@ Vite plugins can also provide hooks that serve Vite-specific purposes. These hoo
   - An array of tag descriptor objects (`{ tag, attrs, children }`) to inject to the existing HTML. Each tag can also specify where it should be injected to (default is prepending to `<head>`)
   - An object containing both as `{ html, tags }`
 
+  By default `order` is `undefined`, with this hook applied after the html has been transformed. In order to inject a script that should go through the Vite plugins pipeline, `order: 'pre'` will apply the hook before processing the HTML. `order: 'post'` applies the hook after all hooks with `order` undefined are applied.
+
   **Basic Example:**
 
   ```js