@nuxt/docs 3.20.2 → 3.21.0

package/4.api/5.kit/5.components.md

@@ -46,28 +46,28 @@ function addComponentsDir (dir: ComponentsDir, opts: { prepend?: boolean } = {})
 
 `dir` An object with the following properties:
 
-| Property           | Type                         | Required | Description                                                                                                     |
-| ------------------ | ---------------------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
-| `path`             | `string`                     | `true`   | Path (absolute or relative) to the directory containing your components. You can use Nuxt aliases (~ or @) to refer to directories inside project or directly use an npm package path similar to require. |
-| `pattern`          | `string \| string[]`{lang="ts"}          | `false`  | Accept Pattern that will be run against specified path.                                                         |
-| `ignore`           | `string[]`                   | `false`  | Ignore patterns that will be run against specified path.                                                        |
-| `prefix`           | `string`                     | `false`  | Prefix all matched components with this string.                                                                |
-| `pathPrefix`       | `boolean`                    | `false`  | Prefix component name by its path.                                                                              |
-| `prefetch`         | `boolean`                    | `false`  | These properties (prefetch/preload) are used in production to configure how components with Lazy prefix are handled by webpack via its magic comments. Learn more on [webpack documentation](https://webpack.js.org/api/module-methods/#magic-comments) |
-| `preload`          | `boolean`                    | `false`  | These properties (prefetch/preload) are used in production to configure how components with Lazy prefix are handled by webpack via its magic comments. Learn more on [webpack documentation](https://webpack.js.org/api/module-methods/#magic-comments) |
-| `isAsync`          | `boolean`                    | `false`  | This flag indicates, component should be loaded async (with a separate chunk) regardless of using Lazy prefix or not. |
-| `extendComponent`  | `(component: Component) => Promise<Component \| void> \| (Component \| void)`{lang="ts"} | `false`  | A function that will be called for each component found in the directory. It accepts a component object and should return a component object or a promise that resolves to a component object. |
-| `global`           | `boolean`                    | `false`  | If enabled, registers components to be globally available.                                                      |
-| `island`           | `boolean`                    | `false`  | If enabled, registers components as islands. You can read more about islands in [`<NuxtIsland/>`](/docs/3.x/api/components/nuxt-island#nuxtisland) component description. |
-| `watch`            | `boolean`                    | `false`  | Watch specified path for changes, including file additions and file deletions.                                  |
-| `extensions`       | `string[]`                   | `false`  | Extensions supported by Nuxt builder.                                                                          |
-| `transpile`        | `'auto' \| boolean`{lang="ts"} | `false`  | Transpile specified path using build.transpile. If set to `'auto'`, it will set `transpile: true` if `node_modules/` is in path. |
+| Property          | Type                                                                                     | Required | Description                                                                                                                                                                                                                                             |
+|-------------------|------------------------------------------------------------------------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `path`            | `string`                                                                                 | `true`   | Path (absolute or relative) to the directory containing your components. You can use Nuxt aliases (~ or @) to refer to directories inside project or directly use an npm package path similar to require.                                               |
+| `pattern`         | `string \| string[]`{lang="ts"}                                                          | `false`  | Accept Pattern that will be run against specified path.                                                                                                                                                                                                 |
+| `ignore`          | `string[]`                                                                               | `false`  | Ignore patterns that will be run against specified path.                                                                                                                                                                                                |
+| `prefix`          | `string`                                                                                 | `false`  | Prefix all matched components with this string.                                                                                                                                                                                                         |
+| `pathPrefix`      | `boolean`                                                                                | `false`  | Prefix component name by its path.                                                                                                                                                                                                                      |
+| `prefetch`        | `boolean`                                                                                | `false`  | These properties (prefetch/preload) are used in production to configure how components with Lazy prefix are handled by webpack via its magic comments. Learn more on [webpack documentation](https://webpack.js.org/api/module-methods/#magic-comments) |
+| `preload`         | `boolean`                                                                                | `false`  | These properties (prefetch/preload) are used in production to configure how components with Lazy prefix are handled by webpack via its magic comments. Learn more on [webpack documentation](https://webpack.js.org/api/module-methods/#magic-comments) |
+| `isAsync`         | `boolean`                                                                                | `false`  | This flag indicates, component should be loaded async (with a separate chunk) regardless of using Lazy prefix or not.                                                                                                                                   |
+| `extendComponent` | `(component: Component) => Promise<Component \| void> \| (Component \| void)`{lang="ts"} | `false`  | A function that will be called for each component found in the directory. It accepts a component object and should return a component object or a promise that resolves to a component object.                                                          |
+| `global`          | `boolean`                                                                                | `false`  | If enabled, registers components to be globally available.                                                                                                                                                                                              |
+| `island`          | `boolean`                                                                                | `false`  | If enabled, registers components as islands. You can read more about islands in [`<NuxtIsland/>`](/docs/3.x/api/components/nuxt-island) component description.                                                                                          |
+| `watch`           | `boolean`                                                                                | `false`  | Watch specified path for changes, including file additions and file deletions.                                                                                                                                                                          |
+| `extensions`      | `string[]`                                                                               | `false`  | Extensions supported by Nuxt builder.                                                                                                                                                                                                                   |
+| `transpile`       | `'auto' \| boolean`{lang="ts"}                                                           | `false`  | Transpile specified path using build.transpile. If set to `'auto'`, it will set `transpile: true` if `node_modules/` is in path.                                                                                                                        |
 
 `opts`
 
-| Property           | Type                         | Required | Description                                                                                                     |
-| ------------------ | ---------------------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
-| `prepend`          | `boolean`                    | `false`  | If set to `true`, the directory will be prepended to the array with `unshift()` instead of `push()`.            |
+| Property  | Type      | Required | Description                                                                                          |
+|-----------|-----------|----------|------------------------------------------------------------------------------------------------------|
+| `prepend` | `boolean` | `false`  | If set to `true`, the directory will be prepended to the array with `unshift()` instead of `push()`. |
 
 ## `addComponent`
 
@@ -109,22 +109,22 @@ function addComponent (options: AddComponentOptions): void
 
 `options`: An object with the following properties:
 
-| Property           | Type                         | Required | Description                                                                                                     |
-| ------------------ | ---------------------------- | -------- | --------------------------------------------------------------------------------------------------------------- |  
-| `name`             | `string`                     | `true`   | Component name.                                                                                                 |
-| `filePath`         | `string`                     | `true`   | Path to the component.                                                                                          |
-| `declarationPath`  | `string`                     | `false`  | Path to component's declaration file. It is used to generate components' [type templates](/docs/3.x/api/kit/templates#addtypetemplate); if not provided, `filePath` is used instead. |
-| `pascalName`       | `string`                     | `false`  | Pascal case component name. If not provided, it will be generated from the component name.                      |
-| `kebabName`        | `string`                     | `false`  | Kebab case component name. If not provided, it will be generated from the component name.                       |
-| `export`           | `string`                     | `false`  | Specify named or default export. If not provided, it will be set to `'default'`.                                 |
-| `shortPath`        | `string`                     | `false`  | Short path to the component. If not provided, it will be generated from the component path.                      |
-| `chunkName`        | `string`                     | `false`  | Chunk name for the component. If not provided, it will be generated from the component name.                     |
-| `prefetch`         | `boolean`                    | `false`  | These properties (prefetch/preload) are used in production to configure how components with Lazy prefix are handled by webpack via its magic comments. Learn more on [webpack documentation](https://webpack.js.org/api/module-methods/#magic-comments) |  
-| `preload`          | `boolean`                    | `false`  | These properties (prefetch/preload) are used in production to configure how components with Lazy prefix are handled by webpack via its magic comments. Learn more on [webpack documentation](https://webpack.js.org/api/module-methods/#magic-comments) |
-| `global`           | `boolean`                    | `false`  | If enabled, registers component to be globally available.                                                        |
-| `island`           | `boolean`                    | `false`  | If enabled, registers component as island. You can read more about islands in [`<NuxtIsland/>`](/docs/3.x/api/components/nuxt-island#nuxtisland) component description. |
-| `mode`             | `'client' \| 'server' \| 'all'`{lang="ts"} | `false`  | This options indicates if component should render on client, server or both. By default, it will render on both client and server. |
-| `priority`         | `number`                     | `false`  | Priority of the component, if multiple components have the same name, the one with the highest priority will be used. |
+| Property          | Type                                       | Required | Description                                                                                                                                                                                                                                             |
+|-------------------|--------------------------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|  
+| `name`            | `string`                                   | `true`   | Component name.                                                                                                                                                                                                                                         |
+| `filePath`        | `string`                                   | `true`   | Path to the component.                                                                                                                                                                                                                                  |
+| `declarationPath` | `string`                                   | `false`  | Path to component's declaration file. It is used to generate components' [type templates](/docs/3.x/api/kit/templates#addtypetemplate); if not provided, `filePath` is used instead.                                                                    |
+| `pascalName`      | `string`                                   | `false`  | Pascal case component name. If not provided, it will be generated from the component name.                                                                                                                                                              |
+| `kebabName`       | `string`                                   | `false`  | Kebab case component name. If not provided, it will be generated from the component name.                                                                                                                                                               |
+| `export`          | `string`                                   | `false`  | Specify named or default export. If not provided, it will be set to `'default'`.                                                                                                                                                                        |
+| `shortPath`       | `string`                                   | `false`  | Short path to the component. If not provided, it will be generated from the component path.                                                                                                                                                             |
+| `chunkName`       | `string`                                   | `false`  | Chunk name for the component. If not provided, it will be generated from the component name.                                                                                                                                                            |
+| `prefetch`        | `boolean`                                  | `false`  | These properties (prefetch/preload) are used in production to configure how components with Lazy prefix are handled by webpack via its magic comments. Learn more on [webpack documentation](https://webpack.js.org/api/module-methods/#magic-comments) |  
+| `preload`         | `boolean`                                  | `false`  | These properties (prefetch/preload) are used in production to configure how components with Lazy prefix are handled by webpack via its magic comments. Learn more on [webpack documentation](https://webpack.js.org/api/module-methods/#magic-comments) |
+| `global`          | `boolean`                                  | `false`  | If enabled, registers component to be globally available.                                                                                                                                                                                               |
+| `island`          | `boolean`                                  | `false`  | If enabled, registers component as island. You can read more about islands in [`<NuxtIsland/>`](/docs/3.x/api/components/nuxt-island) component description.                                                                                            |
+| `mode`            | `'client' \| 'server' \| 'all'`{lang="ts"} | `false`  | This options indicates if component should render on client, server or both. By default, it will render on both client and server.                                                                                                                      |
+| `priority`        | `number`                                   | `false`  | Priority of the component, if multiple components have the same name, the one with the highest priority will be used.                                                                                                                                   |
 
 ### Examples
 

package/4.api/5.kit/6.context.md

@@ -128,7 +128,7 @@ The Nuxt instance as described in the `useNuxt` section.
 ::code-group
 
 ```ts twoslash [requireSiteConfig.ts]
-declare module '@nuxt/schema' {
+declare module 'nuxt/schema' {
   interface NuxtOptions {
     siteConfig: SiteConfig
   }

package/4.api/5.kit/8.layout.md

@@ -15,7 +15,7 @@ Layouts is used to be a wrapper around your pages. It can be used to wrap your p
 Register template as layout and add it to the layouts.
 
 ::note
-In Nuxt 2 `error` layout can also be registered using this utility. In Nuxt 3+ `error` layout [replaced](/docs/3.x/getting-started/error-handling#rendering-an-error-page) with `error.vue` page in project root.
+In Nuxt 2 `error` layout can also be registered using this utility. In Nuxt 3+ `error` layout [replaced](/docs/3.x/getting-started/error-handling#error-page) with `error.vue` page in project root.
 ::
 
 ### Usage

package/4.api/6.advanced/1.hooks.md

@@ -3,103 +3,103 @@ title: 'Lifecycle Hooks'
 description: Nuxt provides a powerful hooking system to expand almost every aspect using hooks.
 ---
 
-:read-more{to="/docs/guide/going-further/hooks"}
+:read-more{to="/docs/3.x/guide/going-further/hooks"}
 
 ## App Hooks (runtime)
 
 Check the [app source code](https://github.com/nuxt/nuxt/blob/main/packages/nuxt/src/app/nuxt.ts#L37) for all available hooks.
 
-Hook                   | Arguments           | Environment     | Description
------------------------|---------------------|-----------------|-------------
-`app:created`          | `vueApp`            | Server & Client | Called when initial `vueApp` instance is created.
-`app:error`            | `err`               | Server & Client | Called when a fatal error occurs.
-`app:error:cleared`    | `{ redirect? }`     | Server & Client | Called when a fatal error occurs.
-`vue:setup`            | -                   | Server & Client | Called when the setup of Nuxt root is initialized. This callback must be synchronous.
-`vue:error`            | `err, target, info` | Server & Client | Called when a vue error propagates to the root component. [Learn More](https://vuejs.org/api/composition-api-lifecycle.html#onerrorcaptured).
-`app:rendered`         | `renderContext`     | Server          | Called when SSR rendering is done.
-`app:redirected`       | -                   | Server          | Called before SSR redirection.
-`app:beforeMount`      | `vueApp`            | Client          | Called before mounting the app, called only on client side.
-`app:mounted`          | `vueApp`            | Client          | Called when Vue app is initialized and mounted in browser.
-`app:suspense:resolve` | `appComponent`      | Client          | On [Suspense](https://vuejs.org/guide/built-ins/suspense.html#suspense) resolved event.
-`app:manifest:update`  | `{ id, timestamp }` | Client          | Called when there is a newer version of your app detected.
-`app:data:refresh`     | `keys?`             | Client          | Called when `refreshNuxtData` is called.
-`link:prefetch`        | `to`                | Client          | Called when a `<NuxtLink>` is observed to be prefetched.
-`page:start`           | `pageComponent?`    | Client          | Called on [Suspense](https://vuejs.org/guide/built-ins/suspense.html#suspense) inside of `NuxtPage` pending event.
-`page:finish`          | `pageComponent?`    | Client          | Called on [Suspense](https://vuejs.org/guide/built-ins/suspense.html#suspense) inside of `NuxtPage` resolved event.
-`page:loading:start`   | -                   | Client          | Called when the `setup()` of the new page is running.
-`page:loading:end`     | -                   | Client          | Called after `page:finish`
-`page:transition:finish`| `pageComponent?`    | Client          | After page transition [onAfterLeave](https://vuejs.org/guide/built-ins/transition.html#javascript-hooks) event.
-`dev:ssr-logs`         | `logs`              | Client          | Called with an array of server-side logs that have been passed to the client (if `features.devLogs` is enabled).
-`page:view-transition:start` | `transition`        | Client          | Called after `document.startViewTransition` is called when [experimental viewTransition support is enabled](/docs/3.x/getting-started/transitions#view-transitions-api-experimental).
+| Hook                         | Arguments           | Environment     | Description                                                                                                                                                                           |
+|------------------------------|---------------------|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `app:created`                | `vueApp`            | Server & Client | Called when initial `vueApp` instance is created.                                                                                                                                     |
+| `app:error`                  | `err`               | Server & Client | Called when a fatal error occurs.                                                                                                                                                     |
+| `app:error:cleared`          | `{ redirect? }`     | Server & Client | Called when a fatal error occurs.                                                                                                                                                     |
+| `vue:setup`                  | -                   | Server & Client | Called when the setup of Nuxt root is initialized. This callback must be synchronous.                                                                                                 |
+| `vue:error`                  | `err, target, info` | Server & Client | Called when a vue error propagates to the root component. [Learn More](https://vuejs.org/api/composition-api-lifecycle#onerrorcaptured).                                              |
+| `app:rendered`               | `renderContext`     | Server          | Called when SSR rendering is done.                                                                                                                                                    |
+| `app:redirected`             | -                   | Server          | Called before SSR redirection.                                                                                                                                                        |
+| `app:beforeMount`            | `vueApp`            | Client          | Called before mounting the app, called only on client side.                                                                                                                           |
+| `app:mounted`                | `vueApp`            | Client          | Called when Vue app is initialized and mounted in browser.                                                                                                                            |
+| `app:suspense:resolve`       | `appComponent`      | Client          | On [Suspense](https://vuejs.org/guide/built-ins/suspense#suspense) resolved event.                                                                                                    |
+| `app:manifest:update`        | `{ id, timestamp }` | Client          | Called when there is a newer version of your app detected.                                                                                                                            |
+| `app:data:refresh`           | `keys?`             | Client          | Called when `refreshNuxtData` is called.                                                                                                                                              |
+| `link:prefetch`              | `to`                | Client          | Called when a `<NuxtLink>` is observed to be prefetched.                                                                                                                              |
+| `page:start`                 | `pageComponent?`    | Client          | Called on [Suspense](https://vuejs.org/guide/built-ins/suspense#suspense) inside of `NuxtPage` pending event.                                                                         |
+| `page:finish`                | `pageComponent?`    | Client          | Called on [Suspense](https://vuejs.org/guide/built-ins/suspense#suspense) inside of `NuxtPage` resolved event.                                                                        |
+| `page:loading:start`         | -                   | Client          | Called when the `setup()` of the new page is running.                                                                                                                                 |
+| `page:loading:end`           | -                   | Client          | Called after `page:finish`                                                                                                                                                            |
+| `page:transition:finish`     | `pageComponent?`    | Client          | After page transition [onAfterLeave](https://vuejs.org/guide/built-ins/transition#javascript-hooks) event.                                                                            |
+| `dev:ssr-logs`               | `logs`              | Client          | Called with an array of server-side logs that have been passed to the client (if `features.devLogs` is enabled).                                                                      |
+| `page:view-transition:start` | `transition`        | Client          | Called after `document.startViewTransition` is called when [experimental viewTransition support is enabled](/docs/3.x/getting-started/transitions#view-transitions-api-experimental). |
 
 ## Nuxt Hooks (build time)
 
 Check the [schema source code](https://github.com/nuxt/nuxt/blob/main/packages/schema/src/types/hooks.ts#L83) for all available hooks.
 
-Hook                     | Arguments                  | Description
--------------------------|----------------------------|-------------
-`kit:compatibility`      | `compatibility, issues`    | Allows extending compatibility checks.
-`ready`                  | `nuxt`                     | Called after Nuxt initialization, when the Nuxt instance is ready to work.
-`close`                  | `nuxt`                     | Called when Nuxt instance is gracefully closing.
-`restart`                | `{ hard?: boolean }`       | To be called to restart the current Nuxt instance.
-`modules:before`         | -                          | Called during Nuxt initialization, before installing user modules.
-`modules:done`           | -                          | Called during Nuxt initialization, after installing user modules.
-`app:resolve`            | `app`                      | Called after resolving the `app` instance.
-`app:templates`          | `app`                      | Called during `NuxtApp` generation, to allow customizing, modifying or adding new files to the build directory (either virtually or to written to `.nuxt`).
-`app:templatesGenerated` | `app`                      | Called after templates are compiled into the [virtual file system](/docs/3.x/directory-structure/nuxt#virtual-file-system) (vfs).
-`build:before`           | -                          | Called before Nuxt bundle builder.
-`build:done`             | -                          | Called after Nuxt bundle builder is complete.
-`build:manifest`         | `manifest`                 | Called during the manifest build by Vite and webpack. This allows customizing the manifest that Nitro will use to render `<script>` and `<link>` tags in the final HTML.
-`builder:generateApp`    | `options`                  | Called before generating the app.
-`builder:watch`          | `event, path`              | Called at build time in development when the watcher spots a change to a file or directory in the project.
-`pages:extend`           | `pages`                    | Called after page routes are scanned from the file system.
-`pages:resolved`         | `pages`                    | Called after page routes have been augmented with scanned metadata.
-`pages:routerOptions`   | `{ files: Array<{ path: string, optional?: boolean }> }` | Called when resolving `router.options` files. Later items in the array override earlier ones.
-`server:devHandler`      | `handler`                  | Called when the dev middleware is being registered on the Nitro dev server.
-`imports:sources`        | `presets`                  | Called at setup allowing modules to extend sources.
-`imports:extend`         | `imports`                  | Called at setup allowing modules to extend imports.
-`imports:context`        | `context`                  | Called when the [unimport](https://github.com/unjs/unimport) context is created.
-`imports:dirs`           | `dirs`                     | Allows extending import directories.
-`components:dirs`        | `dirs`                     | Called within `app:resolve` allowing to extend the directories that are scanned for auto-importable components.
-`components:extend`      | `components`               | Allows extending new components.
-`nitro:config`           | `nitroConfig`              | Called before initializing Nitro, allowing customization of Nitro's configuration.
-`nitro:init`             | `nitro`                    | Called after Nitro is initialized, which allows registering Nitro hooks and interacting directly with Nitro.
-`nitro:build:before`     | `nitro`                    | Called before building the Nitro instance.
-`nitro:build:public-assets`     | `nitro`                    | Called after copying public assets. Allows modifying public assets before Nitro server is built.
-`prerender:routes`       | `ctx`                      | Allows extending the routes to be pre-rendered.
-`build:error`            | `error`                    | Called when an error occurs at build time.
-`prepare:types`          | `options`                  | Called before `@nuxt/cli` writes `.nuxt/tsconfig.json` and `.nuxt/nuxt.d.ts`, allowing addition of custom references and declarations in `nuxt.d.ts`, or directly modifying the options in `tsconfig.json`
-`listen`                 | `listenerServer, listener` | Called when the dev server is loading.
-`schema:extend`          | `schemas`                  | Allows extending default schemas.
-`schema:resolved`        | `schema`                   | Allows extending resolved schema.
-`schema:beforeWrite`     | `schema`                   | Called before writing the given schema.
-`schema:written`         | -                          | Called after the schema is written.
-`vite:extend`            | `viteBuildContext`         | Allows extending Vite default context.
-`vite:extendConfig`      | `viteInlineConfig, env`    | Allows extending Vite default config. **Deprecated in Nuxt 5+.** In Nuxt 5, this operates on a shared configuration rather than separate client/server configs.
-`vite:configResolved`    | `viteInlineConfig, env`    | Allows reading the resolved Vite config. **Deprecated in Nuxt 5+.** In Nuxt 5, this operates on a shared configuration rather than separate client/server configs.
-`vite:serverCreated`     | `viteServer, env`          | Called when the Vite server is created.
-`vite:compiled`          | -                          | Called after Vite server is compiled.
-`webpack:config`         | `webpackConfigs`           | Called before configuring the webpack compiler.
-`webpack:configResolved` | `webpackConfigs`           | Allows reading the resolved webpack config.
-`webpack:compile`        | `options`                  | Called right before compilation.
-`webpack:compiled`       | `options`                  | Called after resources are loaded.
-`webpack:change`         | `shortPath`                | Called on `change` on WebpackBar.
-`webpack:error`          | -                          | Called on `done` if has errors on WebpackBar.
-`webpack:done`           | -                          | Called on `allDone` on WebpackBar.
-`webpack:progress`       | `statesArray`              | Called on `progress` on WebpackBar.
+| Hook                        | Arguments                                                | Description                                                                                                                                                                                                                                                                                  |
+|-----------------------------|----------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `kit:compatibility`         | `compatibility, issues`                                  | Allows extending compatibility checks.                                                                                                                                                                                                                                                       |
+| `ready`                     | `nuxt`                                                   | Called after Nuxt initialization, when the Nuxt instance is ready to work.                                                                                                                                                                                                                   |
+| `close`                     | `nuxt`                                                   | Called when Nuxt instance is gracefully closing.                                                                                                                                                                                                                                             |
+| `restart`                   | `{ hard?: boolean }`                                     | To be called to restart the current Nuxt instance.                                                                                                                                                                                                                                           |
+| `modules:before`            | -                                                        | Called during Nuxt initialization, before installing user modules.                                                                                                                                                                                                                           |
+| `modules:done`              | -                                                        | Called during Nuxt initialization, after installing user modules.                                                                                                                                                                                                                            |
+| `app:resolve`               | `app`                                                    | Called after resolving the `app` instance.                                                                                                                                                                                                                                                   |
+| `app:templates`             | `app`                                                    | Called during `NuxtApp` generation, to allow customizing, modifying or adding new files to the build directory (either virtually or to written to `.nuxt`).                                                                                                                                  |
+| `app:templatesGenerated`    | `app`                                                    | Called after templates are compiled into the [virtual file system](/docs/3.x/directory-structure/nuxt) (vfs).                                                                                                                                                                                |
+| `build:before`              | -                                                        | Called before Nuxt bundle builder.                                                                                                                                                                                                                                                           |
+| `build:done`                | -                                                        | Called after Nuxt bundle builder is complete.                                                                                                                                                                                                                                                |
+| `build:manifest`            | `manifest`                                               | Called during the manifest build by Vite and webpack. This allows customizing the manifest that Nitro will use to render `<script>` and `<link>` tags in the final HTML.                                                                                                                     |
+| `builder:generateApp`       | `options`                                                | Called before generating the app.                                                                                                                                                                                                                                                            |
+| `builder:watch`             | `event, path`                                            | Called at build time in development when the watcher spots a change to a file or directory in the project.                                                                                                                                                                                   |
+| `pages:extend`              | `pages`                                                  | Called after page routes are scanned from the file system.                                                                                                                                                                                                                                   |
+| `pages:resolved`            | `pages`                                                  | Called after page routes have been augmented with scanned metadata.                                                                                                                                                                                                                          |
+| `pages:routerOptions`       | `{ files: Array<{ path: string, optional?: boolean }> }` | Called when resolving `router.options` files. Later items in the array override earlier ones.                                                                                                                                                                                                |
+| `server:devHandler`         | `handler`                                                | Called when the dev middleware is being registered on the Nitro dev server.                                                                                                                                                                                                                  |
+| `imports:sources`           | `presets`                                                | Called at setup allowing modules to extend sources.                                                                                                                                                                                                                                          |
+| `imports:extend`            | `imports`                                                | Called at setup allowing modules to extend imports.                                                                                                                                                                                                                                          |
+| `imports:context`           | `context`                                                | Called when the [unimport](https://github.com/unjs/unimport) context is created.                                                                                                                                                                                                             |
+| `imports:dirs`              | `dirs`                                                   | Allows extending import directories.                                                                                                                                                                                                                                                         |
+| `components:dirs`           | `dirs`                                                   | Called within `app:resolve` allowing to extend the directories that are scanned for auto-importable components.                                                                                                                                                                              |
+| `components:extend`         | `components`                                             | Allows extending new components.                                                                                                                                                                                                                                                             |
+| `nitro:config`              | `nitroConfig`                                            | Called before initializing Nitro, allowing customization of Nitro's configuration.                                                                                                                                                                                                           |
+| `nitro:init`                | `nitro`                                                  | Called after Nitro is initialized, which allows registering Nitro hooks and interacting directly with Nitro.                                                                                                                                                                                 |
+| `nitro:build:before`        | `nitro`                                                  | Called before building the Nitro instance.                                                                                                                                                                                                                                                   |
+| `nitro:build:public-assets` | `nitro`                                                  | Called after copying public assets. Allows modifying public assets before Nitro server is built.                                                                                                                                                                                             |
+| `prerender:routes`          | `ctx`                                                    | Allows extending the routes to be pre-rendered.                                                                                                                                                                                                                                              |
+| `build:error`               | `error`                                                  | Called when an error occurs at build time.                                                                                                                                                                                                                                                   |
+| `prepare:types`             | `options`                                                | Called before `@nuxt/cli` writes TypeScript configuration files (`.nuxt/tsconfig.app.json`, `.nuxt/tsconfig.server.json`, etc.) and `.nuxt/nuxt.d.ts`, allowing addition of custom references and declarations in `nuxt.d.ts`, or directly modifying the options in generated configurations |
+| `listen`                    | `listenerServer, listener`                               | Called when the dev server is loading.                                                                                                                                                                                                                                                       |
+| `schema:extend`             | `schemas`                                                | Allows extending default schemas.                                                                                                                                                                                                                                                            |
+| `schema:resolved`           | `schema`                                                 | Allows extending resolved schema.                                                                                                                                                                                                                                                            |
+| `schema:beforeWrite`        | `schema`                                                 | Called before writing the given schema.                                                                                                                                                                                                                                                      |
+| `schema:written`            | -                                                        | Called after the schema is written.                                                                                                                                                                                                                                                          |
+| `vite:extend`               | `viteBuildContext`                                       | Allows extending Vite default context.                                                                                                                                                                                                                                                       |
+| `vite:extendConfig`         | `viteInlineConfig, env`                                  | Allows extending Vite default config. **Deprecated in Nuxt 5+.** In Nuxt 5, this operates on a shared configuration rather than separate client/server configs.                                                                                                                              |
+| `vite:configResolved`       | `viteInlineConfig, env`                                  | Allows reading the resolved Vite config. **Deprecated in Nuxt 5+.** In Nuxt 5, this operates on a shared configuration rather than separate client/server configs.                                                                                                                           |
+| `vite:serverCreated`        | `viteServer, env`                                        | Called when the Vite server is created.                                                                                                                                                                                                                                                      |
+| `vite:compiled`             | -                                                        | Called after Vite server is compiled.                                                                                                                                                                                                                                                        |
+| `webpack:config`            | `webpackConfigs`                                         | Called before configuring the webpack compiler.                                                                                                                                                                                                                                              |
+| `webpack:configResolved`    | `webpackConfigs`                                         | Allows reading the resolved webpack config.                                                                                                                                                                                                                                                  |
+| `webpack:compile`           | `options`                                                | Called right before compilation.                                                                                                                                                                                                                                                             |
+| `webpack:compiled`          | `options`                                                | Called after resources are loaded.                                                                                                                                                                                                                                                           |
+| `webpack:change`            | `shortPath`                                              | Called on `change` on WebpackBar.                                                                                                                                                                                                                                                            |
+| `webpack:error`             | -                                                        | Called on `done` if has errors on WebpackBar.                                                                                                                                                                                                                                                |
+| `webpack:done`              | -                                                        | Called on `allDone` on WebpackBar.                                                                                                                                                                                                                                                           |
+| `webpack:progress`          | `statesArray`                                            | Called on `progress` on WebpackBar.                                                                                                                                                                                                                                                          |
 
 ## Nitro App Hooks (runtime, server-side)
 
 See [Nitro](https://nitro.build/guide/plugins#available-hooks) for all available hooks.
 
-Hook                   | Arguments             | Description                          | Types
------------------------|-----------------------|--------------------------------------|------------------
-`dev:ssr-logs`         | `{ path, logs }`      | Server                               | Called at the end of a request cycle with an array of server-side logs.
-`render:response`      | `response, { event }` | Called before sending the response.  | [response](https://github.com/nuxt/nuxt/blob/71ef8bd3ff207fd51c2ca18d5a8c7140476780c7/packages/nuxt/src/core/runtime/nitro/renderer.ts#L24), [event](https://github.com/h3js/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38)
-`render:html`          | `html, { event }`     | Called before constructing the HTML. | [html](https://github.com/nuxt/nuxt/blob/71ef8bd3ff207fd51c2ca18d5a8c7140476780c7/packages/nuxt/src/core/runtime/nitro/renderer.ts#L15), [event](https://github.com/h3js/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38)
-`render:island`        | `islandResponse, { event, islandContext }` | Called before constructing the island HTML. | [islandResponse](https://github.com/nuxt/nuxt/blob/e50cabfed1984c341af0d0c056a325a8aec26980/packages/nuxt/src/core/runtime/nitro/renderer.ts#L28), [event](https://github.com/h3js/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38), [islandContext](https://github.com/nuxt/nuxt/blob/e50cabfed1984c341af0d0c056a325a8aec26980/packages/nuxt/src/core/runtime/nitro/renderer.ts#L38)
-`close`               | -                | Called when Nitro is closed. | -
-`error`               | `error, { event? }`          | Called when an error occurs. | [error](https://github.com/nitrojs/nitro/blob/d20ffcbd16fc4003b774445e1a01e698c2bb078a/src/types/runtime/nitro.ts#L48), [event](https://github.com/h3js/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38)
-`request`             | `event`        | Called when a request is received. | [event](https://github.com/h3js/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38)
-`beforeResponse`      | `event, { body }`        | Called before sending the response. | [event](https://github.com/h3js/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38), unknown
-`afterResponse`       | `event, { body }`        | Called after sending the response. | [event](https://github.com/h3js/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38), unknown
+| Hook              | Arguments                                  | Description                                 | Types                                                                                                                                                                                                                                                                                                                                                                                                   |
+|-------------------|--------------------------------------------|---------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `dev:ssr-logs`    | `{ path, logs }`                           | Server                                      | Called at the end of a request cycle with an array of server-side logs.                                                                                                                                                                                                                                                                                                                                 |
+| `render:response` | `response, { event }`                      | Called before sending the response.         | [response](https://github.com/nuxt/nuxt/blob/71ef8bd3ff207fd51c2ca18d5a8c7140476780c7/packages/nuxt/src/core/runtime/nitro/renderer.ts#L24), [event](https://github.com/h3js/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38)                                                                                                                                                         |
+| `render:html`     | `html, { event }`                          | Called before constructing the HTML.        | [html](https://github.com/nuxt/nuxt/blob/71ef8bd3ff207fd51c2ca18d5a8c7140476780c7/packages/nuxt/src/core/runtime/nitro/renderer.ts#L15), [event](https://github.com/h3js/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38)                                                                                                                                                             |
+| `render:island`   | `islandResponse, { event, islandContext }` | Called before constructing the island HTML. | [islandResponse](https://github.com/nuxt/nuxt/blob/e50cabfed1984c341af0d0c056a325a8aec26980/packages/nuxt/src/core/runtime/nitro/renderer.ts#L28), [event](https://github.com/h3js/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38), [islandContext](https://github.com/nuxt/nuxt/blob/e50cabfed1984c341af0d0c056a325a8aec26980/packages/nuxt/src/core/runtime/nitro/renderer.ts#L38) |
+| `close`           | -                                          | Called when Nitro is closed.                | -                                                                                                                                                                                                                                                                                                                                                                                                       |
+| `error`           | `error, { event? }`                        | Called when an error occurs.                | [error](https://github.com/nitrojs/nitro/blob/d20ffcbd16fc4003b774445e1a01e698c2bb078a/src/types/runtime/nitro.ts#L48), [event](https://github.com/h3js/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38)                                                                                                                                                                              |
+| `request`         | `event`                                    | Called when a request is received.          | [event](https://github.com/h3js/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38)                                                                                                                                                                                                                                                                                                      |
+| `beforeResponse`  | `event, { body }`                          | Called before sending the response.         | [event](https://github.com/h3js/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38), unknown                                                                                                                                                                                                                                                                                             |
+| `afterResponse`   | `event, { body }`                          | Called after sending the response.          | [event](https://github.com/h3js/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38), unknown                                                                                                                                                                                                                                                                                             |

package/4.api/index.md

@@ -7,25 +7,25 @@ surround: false
 ---
 
 ::card-group
-  ::card{icon="i-lucide-box" title="Components" to="/docs/api/components/client-only"}
+  ::card{icon="i-lucide-box" title="Components" to="/docs/3.x/api/components/client-only"}
   Explore Nuxt built-in components for pages, layouts, head, and more.
   ::
-  ::card{icon="i-lucide-arrow-left-right" title="Composables" to="/docs/api/composables/use-app-config"}
+  ::card{icon="i-lucide-arrow-left-right" title="Composables" to="/docs/3.x/api/composables/use-app-config"}
   Discover Nuxt composable functions for data-fetching, head management and more.
   ::
-  ::card{icon="i-lucide-square-function" title="Utils" to="/docs/api/utils/dollarfetch"}
+  ::card{icon="i-lucide-square-function" title="Utils" to="/docs/3.x/api/utils/dollarfetch"}
   Learn about Nuxt utility functions for navigation, error handling and more.
   ::
-  ::card{icon="i-lucide-square-terminal" title="Commands" to="/docs/api/commands/add"}
+  ::card{icon="i-lucide-square-terminal" title="Commands" to="/docs/3.x/api/commands/add"}
   List of Nuxt CLI commands to init, analyze, build, and preview your application.
   ::
-  ::card{icon="i-lucide-package" title="Nuxt Kit" to="/docs/api/kit/modules"}
+  ::card{icon="i-lucide-package" title="Nuxt Kit" to="/docs/3.x/api/kit/modules"}
   Understand Nuxt Kit utilities to create modules and control Nuxt.
   ::
-  ::card{icon="i-lucide-brain" title="Advanced" to="/docs/api/advanced/hooks"}
+  ::card{icon="i-lucide-brain" title="Advanced" to="/docs/3.x/api/advanced/hooks"}
   Go deep in Nuxt internals with Nuxt lifecycle hooks.
   ::
-  ::card{icon="i-lucide-cog" title="Nuxt Configuration" to="/docs/api/nuxt-config"}
+  ::card{icon="i-lucide-cog" title="Nuxt Configuration" to="/docs/3.x/api/nuxt-config"}
   Explore all Nuxt configuration options to customize your application.
   ::
 ::

package/5.community/4.contribution.md

@@ -11,7 +11,7 @@ There is a range of different ways you might be able to contribute to the Nuxt e
 The Nuxt ecosystem includes many different projects and organizations:
 
 * [nuxt/](https://github.com/nuxt) - core repositories for the Nuxt framework itself. [**nuxt/nuxt**](https://github.com/nuxt/nuxt) contains the Nuxt framework (both versions 2 and 3).
-* [nuxt-modules/](https://github.com/nuxt-modules) - community-contributed and maintained modules and libraries. There is a [process to migrate a module](/docs/3.x/guide/going-further/modules/#joining-nuxt-modules-and-nuxtjs) to `nuxt-modules`. While these modules have individual maintainers, they are not dependent on a single person.
+* [nuxt-modules/](https://github.com/nuxt-modules) - community-contributed and maintained modules and libraries. There is a [process to migrate a module](/docs/3.x/guide/modules/ecosystem) to `nuxt-modules`. While these modules have individual maintainers, they are not dependent on a single person.
 * [unjs/](https://github.com/unjs) - many of these libraries are used throughout the Nuxt ecosystem. They are designed to be universal libraries that are framework- and environment-agnostic. We welcome contributions and usage by other frameworks and projects.
 
 ## How To Contribute
@@ -42,7 +42,7 @@ If you're working on a feature, then we ask that you **open a feature request is
 
 For typo fixes, it's recommended to batch multiple typo fixes into one pull request to maintain a cleaner commit history.
 
-For bigger changes to Nuxt itself, we recommend that you first [create a Nuxt module](#create-a-module) and implement the feature there. This allows for quick proof-of-concept. You can then [create an RFC](#make-an-rfc) in the form of a discussion. As users adopt it and you gather feedback, it can then be refined and either added to Nuxt core or continue as a standalone module.
+For bigger changes to Nuxt itself, we recommend that you first [create a Nuxt module](/docs/3.x/community/contribution#create-a-module) and implement the feature there. This allows for quick proof-of-concept. You can then [create an RFC](/docs/3.x/community/contribution#make-an-rfc) in the form of a discussion. As users adopt it and you gather feedback, it can then be refined and either added to Nuxt core or continue as a standalone module.
 
 #### Commit Conventions
 
@@ -58,7 +58,7 @@ If you are working in a project with a monorepo, like `nuxt/nuxt`, ensure that y
 
 If you don't know how to send a pull request, we recommend reading [the guide](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).
 
-When sending a pull request, make sure your PR's title also follows the [Commit Convention](#commit-conventions).
+When sending a pull request, make sure your PR's title also follows the [Commit Convention](/docs/3.x/community/contribution#commit-conventions).
 
 If your PR fixes or resolves existing issues, please make sure you mention them in the PR description.
 
@@ -100,13 +100,13 @@ Our aim is ensuring quality and maintaining the joy of collaborating and communi
 
 ### Create a Module
 
-If you've built something with Nuxt that's cool, why not [extract it into a module](/docs/3.x/guide/going-further/modules), so it can be shared with others? We have [many excellent modules already](/modules), but there's always room for more.
+If you've built something with Nuxt that's cool, why not [extract it into a module](/docs/3.x/guide/modules), so it can be shared with others? We have [many excellent modules already](/modules), but there's always room for more.
 
 If you need help while building it, feel free to [check in with us](/docs/3.x/community/getting-help).
 
 ### Make an RFC
 
-We highly recommend [creating a module](#create-a-module) first to test out big new features and gain community adoption.
+We highly recommend [creating a module](/docs/3.x/community/contribution#create-a-module) first to test out big new features and gain community adoption.
 
 If you have done this already, or it's not appropriate to create a new module, then please start by creating a new discussion. Make sure it explains your thinking as clearly as possible. Include code examples or function signatures for new APIs. Reference existing issues or pain points with examples.
 
@@ -126,7 +126,7 @@ The following conventions are _required_ within the `nuxt/` organization and rec
 
 #### Module Conventions
 
-Modules should follow the [Nuxt module template](https://github.com/nuxt/starter/tree/module). See [module guide](/docs/3.x/guide/going-further/modules) for more information.
+Modules should follow the [Nuxt module template](https://github.com/nuxt/starter/tree/module). See [module guide](/docs/3.x/guide/modules) for more information.
 
 #### Use Core `unjs/` Libraries
 
@@ -134,7 +134,7 @@ We recommend the following libraries which are used throughout the ecosystem:
 
 * [pathe](https://github.com/unjs/pathe) - universal path utilities (replacement for node `path`)
 * [ufo](https://github.com/unjs/ufo) - URL parsing and joining utilities
-* [unbuild](https://github.com/unjs/unbuild) - rollup-powered build system
+* [obuild](https://github.com/unjs/obuild) - rolldown-powered build system
 * ... check out the rest of the [unjs/](https://github.com/unjs) organization for many more!
 
 #### Use ESM Syntax and Default to `type: module`
@@ -143,7 +143,7 @@ Most of the Nuxt ecosystem can consume ESM directly. In general we advocate that
 
 #### What's Corepack
 
-[Corepack](https://nodejs.org/api/corepack.html) makes sure you are using the correct version for package manager when you run corresponding commands. Projects might have `packageManager` field in their `package.json`.
+[Corepack](https://github.com/nodejs/corepack) makes sure you are using the correct version for package manager when you run corresponding commands. Projects might have `packageManager` field in their `package.json`.
 
 Under projects with configuration as shown below, Corepack will install `v7.5.0` of `pnpm` (if you don't have it already) and use it to run your commands.
 
@@ -172,7 +172,7 @@ We recommend using [VS Code](https://code.visualstudio.com) along with the [ESLi
 
 #### No Prettier
 
-Since ESLint is already configured to format the code, there is no need to duplicate the functionality with Prettier. To format the code, you can run `yarn lint --fix`, `pnpm lint --fix`, or `bun run lint --fix` or referring the [ESLint section](#use-eslint) for IDE Setup.
+Since ESLint is already configured to format the code, there is no need to duplicate the functionality with Prettier. To format the code, you can run `yarn lint --fix`, `pnpm lint --fix`, `bun run lint --fix`, or `deno run lint --fix` or referring the [ESLint section](/docs/3.x/community/contribution#use-eslint) for IDE Setup.
 
 If you have Prettier installed in your editor, we recommend you disable it when working on the project to avoid conflict.
 
@@ -218,6 +218,6 @@ Here are some tips that may help improve your documentation:
   Nuxt will throw an error.
   ::
 
-::read-more{to="/docs/community/framework-contribution#documentation-guide"}
+::read-more{to="/docs/3.x/community/framework-contribution#documentation-guide"}
 Learn how to contribute to the documentation.
 ::

package/5.community/5.framework-contribution.md

@@ -8,19 +8,19 @@ Once you've read the [general contribution guide](/docs/3.x/community/contributi
 
 ## Monorepo Guide
 
-- `packages/kit`: Toolkit for authoring Nuxt Modules, published as [`@nuxt/kit`](https://npmjs.com/package/@nuxt/kit).
-- `packages/nuxt`: The core of Nuxt, published as [`nuxt`](https://npmjs.com/package/nuxt).
-- `packages/schema`: Cross-version Nuxt typedefs and defaults, published as [`@nuxt/schema`](https://npmjs.com/package/@nuxt/schema).
-- `packages/rspack`: The [Rspack](https://rspack.dev) bundler for Nuxt, published as [`@nuxt/rspack-builder`](https://npmjs.com/package/@nuxt/rspack-builder).
-- `packages/vite`: The [Vite](https://vite.dev) bundler for Nuxt, published as [`@nuxt/vite-builder`](https://npmjs.com/package/@nuxt/vite-builder).
-- `packages/webpack`: The [webpack](https://webpack.js.org) bundler for Nuxt, published as [`@nuxt/webpack-builder`](https://npmjs.com/package/@nuxt/webpack-builder).
+- `packages/kit`: Toolkit for authoring Nuxt modules, published as [`@nuxt/kit`](https://www.npmjs.com/package/@nuxt/kit).
+- `packages/nuxt`: The core of Nuxt, published as [`nuxt`](https://www.npmjs.com/package/nuxt).
+- `packages/schema`: Cross-version Nuxt typedefs and defaults, published as [`@nuxt/schema`](https://www.npmjs.com/package/@nuxt/schema).
+- `packages/rspack`: The [Rspack](https://rspack.rs) bundler for Nuxt, published as [`@nuxt/rspack-builder`](https://www.npmjs.com/package/@nuxt/rspack-builder).
+- `packages/vite`: The [Vite](https://vite.dev) bundler for Nuxt, published as [`@nuxt/vite-builder`](https://www.npmjs.com/package/@nuxt/vite-builder).
+- `packages/webpack`: The [webpack](https://webpack.js.org) bundler for Nuxt, published as [`@nuxt/webpack-builder`](https://www.npmjs.com/package/@nuxt/webpack-builder).
 
 ## Setup
 
 To contribute to Nuxt, you need to set up a local environment.
 
-1. [Fork](https://help.github.com/articles/fork-a-repo) the [`nuxt/nuxt`](https://github.com/nuxt/nuxt)  repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository) it to your local device.
-2. Ensure using the latest [Node.js](https://nodejs.org/en) (20.x)
+1. [Fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) the [`nuxt/nuxt`](https://github.com/nuxt/nuxt)  repository to your own GitHub account and then [clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) it to your local device.
+2. Ensure using the latest [Node.js](https://nodejs.org/en)
 3. Enable [Corepack](https://github.com/nodejs/corepack) to have `pnpm` and `yarn`
     ```bash [Terminal]
     corepack enable
@@ -42,7 +42,7 @@ To contribute to Nuxt, you need to set up a local environment.
     git checkout -b my-new-branch
     ```
 
-Then, test your changes against the [playground](#playground) and [test](#testing) your changes before submitting a pull request.
+Then, test your changes against the [playground](/docs/3.x/community/framework-contribution#playground) and [test](/docs/3.x/community/framework-contribution#testing) your changes before submitting a pull request.
 
 ### Playground