@nuxt/docs 3.20.2 → 3.21.0

package/4.api/5.kit/10.templates.md

@@ -48,14 +48,14 @@ function addTemplate (template: NuxtTemplate | string): ResolvedNuxtTemplate
 
 **template**: A template object or a string with the path to the template. If a string is provided, it will be converted to a template object with `src` set to the string value. If a template object is provided, it must have the following properties:
 
-| Property   | Type                                                                 | Required | Description                                                                                                     |
-| ---------- | -------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
-| `src`      | `string`                                                             | `false`  | Path to the template. If `src` is not provided, `getContents` must be provided instead.                         |
-| `filename` | `string`                                                             | `false`  | Filename of the template. If `filename` is not provided, it will be generated from the `src` path. In this case, the `src` option is required. |
-| `dst`      | `string`                                                             | `false`  | Path to the destination file. If `dst` is not provided, it will be generated from the `filename` path and nuxt `buildDir` option. |
-| `options`  | `Options`                                                           | `false`  | Options to pass to the template.                                                                                |
+| Property      | Type                                                      | Required | Description                                                                                                                                                                      |
+|---------------|-----------------------------------------------------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `src`         | `string`                                                  | `false`  | Path to the template. If `src` is not provided, `getContents` must be provided instead.                                                                                          |
+| `filename`    | `string`                                                  | `false`  | Filename of the template. If `filename` is not provided, it will be generated from the `src` path. In this case, the `src` option is required.                                   |
+| `dst`         | `string`                                                  | `false`  | Path to the destination file. If `dst` is not provided, it will be generated from the `filename` path and nuxt `buildDir` option.                                                |
+| `options`     | `Options`                                                 | `false`  | Options to pass to the template.                                                                                                                                                 |
 | `getContents` | `(data: Options) => string \| Promise<string>`{lang="ts"} | `false`  | A function that will be called with the `options` object. It should return a string or a promise that resolves to a string. If `src` is provided, this function will be ignored. |
-| `write`    | `boolean`                                                            | `false`  | If set to `true`, the template will be written to the destination file. Otherwise, the template will be used only in virtual filesystem. |
+| `write`       | `boolean`                                                 | `false`  | If set to `true`, the template will be written to the destination file. Otherwise, the template will be used only in virtual filesystem.                                         |
 
 ### Examples
 
@@ -133,20 +133,20 @@ function addTypeTemplate (template: NuxtTypeTemplate | string, context?: { nitro
 
 **template**: A template object or a string with the path to the template. If a string is provided, it will be converted to a template object with `src` set to the string value. If a template object is provided, it must have the following properties:
 
-| Property   | Type                                                                 | Required | Description                                                                                                     |
-| ---------- | -------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
-| `src`      | `string`                                                             | `false`  | Path to the template. If `src` is not provided, `getContents` must be provided instead.                         |
-| `filename` | `string`                                                             | `false`  | Filename of the template. If `filename` is not provided, it will be generated from the `src` path. In this case, the `src` option is required. |
-| `dst`      | `string`                                                             | `false`  | Path to the destination file. If `dst` is not provided, it will be generated from the `filename` path and nuxt `buildDir` option. |
-| `options`  | `Options`                                                            | `false`  | Options to pass to the template.                                                                                |
+| Property      | Type                                                      | Required | Description                                                                                                                                                                      |
+|---------------|-----------------------------------------------------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `src`         | `string`                                                  | `false`  | Path to the template. If `src` is not provided, `getContents` must be provided instead.                                                                                          |
+| `filename`    | `string`                                                  | `false`  | Filename of the template. If `filename` is not provided, it will be generated from the `src` path. In this case, the `src` option is required.                                   |
+| `dst`         | `string`                                                  | `false`  | Path to the destination file. If `dst` is not provided, it will be generated from the `filename` path and nuxt `buildDir` option.                                                |
+| `options`     | `Options`                                                 | `false`  | Options to pass to the template.                                                                                                                                                 |
 | `getContents` | `(data: Options) => string \| Promise<string>`{lang="ts"} | `false`  | A function that will be called with the `options` object. It should return a string or a promise that resolves to a string. If `src` is provided, this function will be ignored. |
 
 **context**: An optional context object can be passed to control where the type is added. If omitted, the type will only be added to the Nuxt context. This object supports the following properties:
 
-| Property   | Type                                                                 | Required | Description                                                                                                     |
-| ---------- | -------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
-| `nuxt`     | `boolean`                                                            | `false`  | If set to `true`, the type will be added to the Nuxt context.                                                   |
-| `nitro`    | `boolean`                                                            | `false`  | If set to `true`, the type will be added to the Nitro context.                                                  |
+| Property | Type      | Required | Description                                                    |
+|----------|-----------|----------|----------------------------------------------------------------|
+| `nuxt`   | `boolean` | `false`  | If set to `true`, the type will be added to the Nuxt context.  |
+| `nitro`  | `boolean` | `false`  | If set to `true`, the type will be added to the Nitro context. |
 
 ### Examples
 
@@ -226,9 +226,9 @@ function addServerTemplate (template: NuxtServerTemplate): NuxtServerTemplate
 
 **template**: A template object. It must have the following properties:
 
-| Property      | Type                                         | Required | Description                                                                                                     |
-| ------------- | ---------------------------------------------| -------- | --------------------------------------------------------------------------------------------------------------- |
-| `filename`    | `string`                                     | `true`   | Filename of the template.                                                                                       |
+| Property      | Type                                         | Required | Description                                                                                                                 |
+|---------------|----------------------------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------|
+| `filename`    | `string`                                     | `true`   | Filename of the template.                                                                                                   |
 | `getContents` | `() => string \| Promise<string>`{lang="ts"} | `true`   | A function that will be called with the `options` object. It should return a string or a promise that resolves to a string. |
 
 ### Examples
@@ -304,6 +304,6 @@ async function updateTemplates (options: UpdateTemplatesOptions): void
 
 **options**: Options to pass to the template. This object can have the following property:
 
-| Property   | Type                                                                 | Required | Description                                                                                                     |
-| ---------- | -------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
-| `filter`    | `(template: ResolvedNuxtTemplate) => boolean`{lang="ts"} | `false`  | A function that will be called with the `template` object. It should return a boolean indicating whether the template should be regenerated. If `filter` is not provided, all templates will be regenerated. |
+| Property | Type                                                     | Required | Description                                                                                                                                                                                                  |
+|----------|----------------------------------------------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `filter` | `(template: ResolvedNuxtTemplate) => boolean`{lang="ts"} | `false`  | A function that will be called with the `template` object. It should return a boolean indicating whether the template should be regenerated. If `filter` is not provided, all templates will be regenerated. |

package/4.api/5.kit/11.nitro.md

@@ -41,13 +41,13 @@ function addServerHandler (handler: NitroEventHandler): void
 
 **handler**: A handler object with the following properties:
 
-| Property    | Type            | Required | Description                                                                                                     |
-| ----------- | --------------  | -------- | --------------------------------------------------------------------------------------------------------------- |
-| `handler`   | `string`        | `true`   | Path to event handler.                                                                                          |
-| `route`     | `string`        | `false`  | Path prefix or route. If an empty string used, will be used as a middleware.                                    |
-| `middleware`| `boolean`       | `false`  | Specifies this is a middleware handler. Middleware are called on every route and should normally return nothing to pass to the next handlers. |
-| `lazy`      | `boolean`       | `false`  | Use lazy loading to import the handler. This is useful when you only want to load the handler on demand.        |
-| `method`    | `string`        | `false`  | Router method matcher. If handler name contains method name, it will be used as a default value.                |
+| Property     | Type      | Required | Description                                                                                                                                   |
+|--------------|-----------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------|
+| `handler`    | `string`  | `true`   | Path to event handler.                                                                                                                        |
+| `route`      | `string`  | `false`  | Path prefix or route. If an empty string used, will be used as a middleware.                                                                  |
+| `middleware` | `boolean` | `false`  | Specifies this is a middleware handler. Middleware are called on every route and should normally return nothing to pass to the next handlers. |
+| `lazy`       | `boolean` | `false`  | Use lazy loading to import the handler. This is useful when you only want to load the handler on demand.                                      |
+| `method`     | `string`  | `false`  | Router method matcher. If handler name contains method name, it will be used as a default value.                                              |
 
 ### Examples
 
@@ -117,7 +117,7 @@ export default defineNuxtModule({
 
 ```ts twoslash
 // @errors: 2391
-import type { NitroDevEventHandler } from 'nitropack'
+import type { NitroDevEventHandler } from 'nitropack/types'
 // ---cut---
 function addDevServerHandler (handler: NitroDevEventHandler): void
 ```
@@ -126,10 +126,10 @@ function addDevServerHandler (handler: NitroDevEventHandler): void
 
 **handler**: A handler object with the following properties:
 
-| Property    | Type            | Required | Description                                                                                                     |
-| ----------- | --------------  | -------- | --------------------------------------------------------------------------------------------------------------- |
-| `handler`   | `EventHandler`  | `true`   | Event handler.                                                                                                  |
-| `route`     | `string`        | `false`  | Path prefix or route. If an empty string used, will be used as a middleware.                                    |
+| Property  | Type           | Required | Description                                                                  |
+|-----------|----------------|----------|------------------------------------------------------------------------------|
+| `handler` | `EventHandler` | `true`   | Event handler.                                                               |
+| `route`   | `string`       | `false`  | Path prefix or route. If an empty string used, will be used as a middleware. |
 
 ### Examples
 
@@ -222,9 +222,9 @@ function addServerPlugin (plugin: string): void
 
 ### Parameters
 
-| Property    | Type            | Required | Description                                                                                                     |
-| ----------- | --------------  | -------- | --------------------------------------------------------------------------------------------------------------- |
-| `plugin`    | `string`        | `true`   | Path to the plugin. The plugin must export a default function that accepts the Nitro instance as an argument.   |
+| Property | Type     | Required | Description                                                                                                   |
+|----------|----------|----------|---------------------------------------------------------------------------------------------------------------|
+| `plugin` | `string` | `true`   | Path to the plugin. The plugin must export a default function that accepts the Nitro instance as an argument. |
 
 ### Examples
 
@@ -293,9 +293,9 @@ function addPrerenderRoutes (routes: string | string[]): void
 
 ### Parameters
 
-| Property    | Type                            | Required | Description                                    |
-| ----------- | ------------------------------- | -------- | ---------------------------------------------- |
-| `routes`    | `string \| string[]`{lang="ts"} | `true`   | A route or an array of routes to prerender.    |
+| Property | Type                            | Required | Description                                 |
+|----------|---------------------------------|----------|---------------------------------------------|
+| `routes` | `string \| string[]`{lang="ts"} | `true`   | A route or an array of routes to prerender. |
 
 ## `addServerImports`
 
@@ -333,16 +333,16 @@ function addServerImports (dirs: Import | Import[]): void
 
 `imports`: An object or an array of objects with the following properties:
 
-| Property           | Type                         | Required | Description                                                                                                     |
-| ------------------ | ---------------------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
-| `name`             | `string`                     | `true`   | Import name to be detected.                                                                                     |
-| `from`             | `string`                     | `true`   | Module specifier to import from.                                                                                |
-| `priority`         | `number`                     | `false`  | Priority of the import; if multiple imports have the same name, the one with the highest priority will be used. |
-| `disabled`         | `boolean`                    | `false`  | If this import is disabled.                                                                                     |
-| `meta`             | `Record<string, any>`        | `false`  | Metadata of the import.                                                                                         |
-| `type`             | `boolean`                    | `false`  | If this import is a pure type import.                                                                           |
-| `typeFrom`         | `string`                     | `false`  | Use this as the `from` value when generating type declarations.                                                 |
-| `as`               | `string`                     | `false`  | Import as this name.                                                                                            |
+| Property   | Type                  | Required | Description                                                                                                     |
+|------------|-----------------------|----------|-----------------------------------------------------------------------------------------------------------------|
+| `name`     | `string`              | `true`   | Import name to be detected.                                                                                     |
+| `from`     | `string`              | `true`   | Module specifier to import from.                                                                                |
+| `priority` | `number`              | `false`  | Priority of the import; if multiple imports have the same name, the one with the highest priority will be used. |
+| `disabled` | `boolean`             | `false`  | If this import is disabled.                                                                                     |
+| `meta`     | `Record<string, any>` | `false`  | Metadata of the import.                                                                                         |
+| `type`     | `boolean`             | `false`  | If this import is a pure type import.                                                                           |
+| `typeFrom` | `string`              | `false`  | Use this as the `from` value when generating type declarations.                                                 |
+| `as`       | `string`              | `false`  | Import as this name.                                                                                            |
 
 ## `addServerImportsDir`
 
@@ -373,10 +373,10 @@ function addServerImportsDir (dirs: string | string[], opts: { prepend?: boolean
 
 ### Parameters
 
-| Property    | Type                            | Required | Description                                    |
-| ----------- | ------------------------------- | -------- | ---------------------------------------------- |
-| `dirs`      | `string \| string[]`{lang="ts"} | `true`   | A directory or an array of directories to register to be scanned by Nitro. |
-| `opts`      | `{ prepend?: boolean }`         | `false`  | Options for the import directory. If `prepend` is `true`, the directory is added to the beginning of the scan list. |
+| Property | Type                            | Required | Description                                                                                                         |
+|----------|---------------------------------|----------|---------------------------------------------------------------------------------------------------------------------|
+| `dirs`   | `string \| string[]`{lang="ts"} | `true`   | A directory or an array of directories to register to be scanned by Nitro.                                          |
+| `opts`   | `{ prepend?: boolean }`         | `false`  | Options for the import directory. If `prepend` is `true`, the directory is added to the beginning of the scan list. |
 
 ### Examples
 
@@ -453,10 +453,10 @@ function addServerScanDir (dirs: string | string[], opts: { prepend?: boolean })
 
 ### Parameters
 
-| Property    | Type                            | Required | Description                                    |
-| ----------- | ------------------------------- | -------- | ---------------------------------------------- |
-| `dirs`      | `string \| string[]`{lang="ts"} | `true`   | A directory or an array of directories to register to be scanned for by Nitro as server dirs. |
-| `opts`      | `{ prepend?: boolean }`         | `false`  | Options for the import directory. If `prepend` is `true`, the directory is added to the beginning of the scan list. |
+| Property | Type                            | Required | Description                                                                                                         |
+|----------|---------------------------------|----------|---------------------------------------------------------------------------------------------------------------------|
+| `dirs`   | `string \| string[]`{lang="ts"} | `true`   | A directory or an array of directories to register to be scanned for by Nitro as server dirs.                       |
+| `opts`   | `{ prepend?: boolean }`         | `false`  | Options for the import directory. If `prepend` is `true`, the directory is added to the beginning of the scan list. |
 
 ### Examples
 

package/4.api/5.kit/12.resolving.md

@@ -8,11 +8,11 @@ links:
     size: xs
 ---
 
-Sometimes you need to resolve a paths: relative to the current module, with unknown name or extension. For example, you may want to add a plugin that is located in the same directory as the module. To handle this cases, nuxt provides a set of utilities to resolve paths. `resolvePath` and `resolveAlias` are used to resolve paths relative to the current module. `findPath` is used to find first existing file in given paths. `createResolver` is used to create resolver relative to base path.
+Sometimes you need to resolve a path relative to the current module without knowing the name or extension. For example, you may want to add a plugin that is located in the same directory as the module. To handle these cases, Nuxt provides a set of utilities to resolve paths. `resolvePath` and `resolveAlias` are used to resolve paths relative to the current module. `findPath` is used to find the first existing file in a given set of paths. `createResolver` is used to create a resolver relative to the base path.
 
 ## `resolvePath`
 
-Resolves full path to a file or directory respecting Nuxt alias and extensions options. If path could not be resolved, normalized input path will be returned.
+Resolves the full path to a file or directory, respecting Nuxt alias and extensions options. If a path could not be resolved, a normalized input path will be returned.
 
 ### Usage
 

package/4.api/5.kit/14.builder.md

@@ -83,8 +83,8 @@ import type { ExtendViteConfigOptions } from '@nuxt/kit'
 function extendViteConfig (callback: ((config: ViteConfig) => void), options?: ExtendViteConfigOptions): void
 ```
 
-::read-more{to="https://vite.dev/config" target="_blank" icon="i-simple-icons-vite"}
-Checkout Vite website for more information about its configuration.
+::read-more{to="https://vite.dev/config/" target="_blank" icon="i-simple-icons-vite"}
+Check out the Vite website for more information about its configuration.
 ::
 
 ### Parameters
@@ -93,13 +93,13 @@ Checkout Vite website for more information about its configuration.
 
 **`options`**: Options to pass to the callback function. This object can have the following properties:
 
-| Property  | Type      | Required | Description                                                                                                 |
-| --------- | --------- | -------- | ------------------------------------------------------------------------------------------------------------ |
-| `dev`     | `boolean` | `false`  | If set to `true`, the callback function will be called when building in development mode.                    |
-| `build`   | `boolean` | `false`  | If set to `true`, the callback function will be called when building in production mode.                     |
+| Property  | Type      | Required | Description                                                                                                                                                                   |
+|-----------|-----------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `dev`     | `boolean` | `false`  | If set to `true`, the callback function will be called when building in development mode.                                                                                     |
+| `build`   | `boolean` | `false`  | If set to `true`, the callback function will be called when building in production mode.                                                                                      |
 | `server`  | `boolean` | `false`  | If set to `true`, the callback function will be called when building the server bundle. **Deprecated in Nuxt 5+.** Use `addVitePlugin()` with `applyToEnvironment()` instead. |
 | `client`  | `boolean` | `false`  | If set to `true`, the callback function will be called when building the client bundle. **Deprecated in Nuxt 5+.** Use `addVitePlugin()` with `applyToEnvironment()` instead. |
-| `prepend` | `boolean` | `false`  | If set to `true`, the callback function will be prepended to the array with `unshift()` instead of `push()`. |
+| `prepend` | `boolean` | `false`  | If set to `true`, the callback function will be prepended to the array with `unshift()` instead of `push()`.                                                                  |
 
 ## `extendWebpackConfig`
 
@@ -132,8 +132,8 @@ import type { ExtendWebpackConfigOptions } from '@nuxt/kit'
 function extendWebpackConfig (callback: ((config: WebpackConfig) => void), options?: ExtendWebpackConfigOptions): void
 ```
 
-::read-more{to="https://webpack.js.org/configuration" target="_blank" icon="i-simple-icons-webpack"}
-Checkout webpack website for more information about its configuration.
+::read-more{to="https://webpack.js.org/configuration/" target="_blank" icon="i-simple-icons-webpack"}
+Check out webpack website for more information about its configuration.
 ::
 
 ### Parameters
@@ -143,7 +143,7 @@ Checkout webpack website for more information about its configuration.
 **`options`**: Options to pass to the callback function. This object can have the following properties:
 
 | Property  | Type      | Required | Description                                                                                                  |
-| --------- | --------- | -------- | ------------------------------------------------------------------------------------------------------------ |
+|-----------|-----------|----------|--------------------------------------------------------------------------------------------------------------|
 | `dev`     | `boolean` | `false`  | If set to `true`, the callback function will be called when building in development mode.                    |
 | `build`   | `boolean` | `false`  | If set to `true`, the callback function will be called when building in production mode.                     |
 | `server`  | `boolean` | `false`  | If set to `true`, the callback function will be called when building the server bundle.                      |
@@ -202,22 +202,34 @@ function addVitePlugin (pluginOrGetter: VitePlugin | VitePlugin[] | (() => ViteP
 ```
 
 ::tip
-See [Vite website](https://vite.dev/guide/api-plugin.html) for more information about Vite plugins. You can also use [this repository](https://github.com/vitejs/awesome-vite#plugins) to find a plugin that suits your needs.
+See [Vite website](https://vite.dev/guide/api-plugin) for more information about Vite plugins. You can also use [this repository](https://github.com/vitejs/awesome-vite#plugins) to find a plugin that suits your needs.
 ::
 
 ### Parameters
 
-**`pluginOrGetter`**: A Vite plugin instance or an array of Vite plugin instances. If a function is provided, it must return a Vite plugin instance or an array of Vite plugin instances.
+**`pluginOrGetter`**: A Vite plugin instance or an array of Vite plugin instances. If a function is provided, it must return a Vite plugin instance or an array of Vite plugin instances. The function can also be async or return a Promise, which is useful for lazy-loading plugins:
+
+```ts twoslash
+// @errors: 2307
+import { addVitePlugin, defineNuxtModule } from '@nuxt/kit'
+
+export default defineNuxtModule({
+  setup () {
+    // Lazy load the plugin - only imported when the build actually runs
+    addVitePlugin(() => import('my-vite-plugin').then(r => r.default()))
+  },
+})
+```
 
 **`options`**: Options to pass to the callback function. This object can have the following properties:
 
-| Property  | Type      | Required | Description                                                                                                 |
-| --------- | --------- | -------- | ------------------------------------------------------------------------------------------------------------ |
-| `dev`     | `boolean` | `false`  | If set to `true`, the callback function will be called when building in development mode.                    |
-| `build`   | `boolean` | `false`  | If set to `true`, the callback function will be called when building in production mode.                     |
+| Property  | Type      | Required | Description                                                                                                                                            |
+|-----------|-----------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `dev`     | `boolean` | `false`  | If set to `true`, the callback function will be called when building in development mode.                                                              |
+| `build`   | `boolean` | `false`  | If set to `true`, the callback function will be called when building in production mode.                                                               |
 | `server`  | `boolean` | `false`  | If set to `true`, the callback function will be called when building the server bundle. **Deprecated in Nuxt 5+.** Use `applyToEnvironment()` instead. |
 | `client`  | `boolean` | `false`  | If set to `true`, the callback function will be called when building the client bundle. **Deprecated in Nuxt 5+.** Use `applyToEnvironment()` instead. |
-| `prepend` | `boolean` | `false`  | If set to `true`, the callback function will be prepended to the array with `unshift()` instead of `push()`. |
+| `prepend` | `boolean` | `false`  | If set to `true`, the callback function will be prepended to the array with `unshift()` instead of `push()`.                                           |
 
 ## `addWebpackPlugin`
 
@@ -261,17 +273,17 @@ function addWebpackPlugin (pluginOrGetter: WebpackPluginInstance | WebpackPlugin
 ```
 
 ::tip
-See [webpack website](https://webpack.js.org/concepts/plugins) for more information about webpack plugins. You can also use [this collection](https://webpack.js.org/awesome-webpack/#webpack-plugins) to find a plugin that suits your needs.
+See [webpack website](https://webpack.js.org/concepts/plugins/) for more information about webpack plugins. You can also use [this collection](https://webpack.js.org/awesome-webpack/#webpack-plugins) to find a plugin that suits your needs.
 ::
 
 ### Parameters
 
-**`pluginOrGetter`**: A webpack plugin instance or an array of webpack plugin instances. If a function is provided, it must return a webpack plugin instance or an array of webpack plugin instances.
+**`pluginOrGetter`**: A webpack plugin instance or an array of webpack plugin instances. If a function is provided, it must return a webpack plugin instance or an array of webpack plugin instances. The function can also be async or return a Promise, enabling lazy-loading of plugins.
 
 **`options`**: Options to pass to the callback function. This object can have the following properties:
 
-| Property  | Type      | Required | Description                                                                                                 |
-| --------- | --------- | -------- | ------------------------------------------------------------------------------------------------------------ |
+| Property  | Type      | Required | Description                                                                                                  |
+|-----------|-----------|----------|--------------------------------------------------------------------------------------------------------------|
 | `dev`     | `boolean` | `false`  | If set to `true`, the callback function will be called when building in development mode.                    |
 | `build`   | `boolean` | `false`  | If set to `true`, the callback function will be called when building in production mode.                     |
 | `server`  | `boolean` | `false`  | If set to `true`, the callback function will be called when building the server bundle.                      |
@@ -306,8 +318,8 @@ function addBuildPlugin (pluginFactory: AddBuildPluginFactory, options?: ExtendC
 
 **`options`**: Options to pass to the callback function. This object can have the following properties:
 
-| Property  | Type      | Required | Description                                                                                                 |
-| --------- | --------- | -------- | ------------------------------------------------------------------------------------------------------------ |
+| Property  | Type      | Required | Description                                                                                                  |
+|-----------|-----------|----------|--------------------------------------------------------------------------------------------------------------|
 | `dev`     | `boolean` | `false`  | If set to `true`, the callback function will be called when building in development mode.                    |
 | `build`   | `boolean` | `false`  | If set to `true`, the callback function will be called when building in production mode.                     |
 | `server`  | `boolean` | `false`  | If set to `true`, the callback function will be called when building the server bundle.                      |

package/4.api/5.kit/16.layers.md

@@ -57,13 +57,13 @@ interface LayerDirectories {
   readonly public: string
   /** Nuxt srcDir (`/app/` by default) */
   readonly app: string
-  /** Layouts directory (`/app/layouts` by default) */
+  /** Layouts directory (`/layouts` by default) */
   readonly appLayouts: string
-  /** Middleware directory (`/app/middleware` by default) */
+  /** Middleware directory (`/middleware` by default) */
   readonly appMiddleware: string
-  /** Pages directory (`/app/pages` by default) */
+  /** Pages directory (`/pages` by default) */
   readonly appPages: string
-  /** Plugins directory (`/app/plugins` by default) */
+  /** Plugins directory (`/plugins` by default) */
   readonly appPlugins: string
 }
 ```
@@ -85,18 +85,18 @@ This ordering matches Nuxt's layer resolution system, where user-defined configu
 
 **`LayerDirectories`**: An object containing the resolved directory paths for a layer.
 
-| Property        | Type     | Description                                                                    |
-| --------------- | -------- | ------------------------------------------------------------------------------ |
-| `root`          | `string` | The root directory of the layer (equivalent to `rootDir`)                     |
-| `server`        | `string` | The server directory for Nitro server-side code                               |
-| `modules`       | `string` | The local modules directory                                                    |
-| `shared`        | `string` | The shared directory for code used by both client and server                  |
-| `app`           | `string` | The source directory of the layer (equivalent to `srcDir`)                    |
-| `public`        | `string` | The public directory for static assets                                         |
-| `appLayouts`    | `string` | The layouts directory for Vue layout components                                |
-| `appMiddleware` | `string` | The middleware directory for route middleware                                  |
-| `appPages`      | `string` | The pages directory for file-based routing                                    |
-| `appPlugins`    | `string` | The plugins directory for Nuxt plugins                                        |
+| Property        | Type     | Description                                                  |
+|-----------------|----------|--------------------------------------------------------------|
+| `root`          | `string` | The root directory of the layer (equivalent to `rootDir`)    |
+| `server`        | `string` | The server directory for Nitro server-side code              |
+| `modules`       | `string` | The local modules directory                                  |
+| `shared`        | `string` | The shared directory for code used by both client and server |
+| `app`           | `string` | The source directory of the layer (equivalent to `srcDir`)   |
+| `public`        | `string` | The public directory for static assets                       |
+| `appLayouts`    | `string` | The layouts directory for Vue layout components              |
+| `appMiddleware` | `string` | The middleware directory for route middleware                |
+| `appPages`      | `string` | The pages directory for file-based routing                   |
+| `appPlugins`    | `string` | The plugins directory for Nuxt plugins                       |
 
 ### Examples
 

package/4.api/5.kit/2.programmatic.md

@@ -4,7 +4,7 @@ description: Nuxt Kit provides a set of utilities to help you work with Nuxt pro
 links:
   - label: Source
     icon: i-simple-icons-github
-    to: https://github.com/nuxt/nuxt/blob/main/packages/kit/src/loader
+    to: https://github.com/nuxt/nuxt/tree/main/packages/kit/src/loader
     size: xs
 ---
 
@@ -31,7 +31,7 @@ function loadNuxt (loadOptions?: LoadNuxtOptions): Promise<Nuxt>
 
 ## `buildNuxt`
 
-Build Nuxt programmatically. It will invoke the builder (currently [@nuxt/vite-builder](https://github.com/nuxt/nuxt/blob/main/packages/vite) or [@nuxt/webpack-builder](https://github.com/nuxt/nuxt/blob/main/packages/webpack)) to bundle the application.
+Build Nuxt programmatically. It will invoke the builder (currently [@nuxt/vite-builder](https://github.com/nuxt/nuxt/tree/main/packages/vite) or [@nuxt/webpack-builder](https://github.com/nuxt/nuxt/tree/main/packages/webpack)) to bundle the application.
 
 ### Type
 

package/4.api/5.kit/3.compatibility.md

@@ -63,7 +63,7 @@ function assertNuxtCompatibility (constraints: NuxtCompatibility, nuxt?: Nuxt):
 
 ### Parameters
 
-**`constraints`**: Version and builder constraints to check against. Refer to the [constraints table in `checkNuxtCompatibility`](#parameters) for details.
+**`constraints`**: Version and builder constraints to check against. Refer to the [constraints table in `checkNuxtCompatibility`](/docs/3.x/api/kit/compatibility#parameters) for details.
 
 **`nuxt`**: Nuxt instance. If not provided, it will be retrieved from the context via `useNuxt()` call.
 
@@ -96,7 +96,7 @@ function hasNuxtCompatibility (constraints: NuxtCompatibility, nuxt?: Nuxt): Pro
 
 ### Parameters
 
-**`constraints`**: Version and builder constraints to check against. Refer to the [constraints table in `checkNuxtCompatibility`](#parameters) for details.
+**`constraints`**: Version and builder constraints to check against. Refer to the [constraints table in `checkNuxtCompatibility`](/docs/3.x/api/kit/compatibility#parameters) for details.
 
 **`nuxt`**: Nuxt instance. If not provided, it will be retrieved from the context via `useNuxt()` call.
 

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

@@ -58,16 +58,16 @@ function addImports (imports: Import | Import[]): void
 
 `imports`: An object or an array of objects with the following properties:
 
-| Property           | Type                         | Required | Description                                                                                                     |
-| ------------------ | ---------------------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
-| `name`             | `string`                     | `true`   | Import name to be detected.                                                                                     |
-| `from`             | `string`                     | `true`   | Module specifier to import from.                                                                                |
-| `priority`         | `number`                     | `false`  | Priority of the import; if multiple imports have the same name, the one with the highest priority will be used. |
-| `disabled`         | `boolean`                    | `false`  | If this import is disabled.                                                                                     |
-| `meta`             | `Record<string, any>`        | `false`  | Metadata of the import.                                                                                         |
-| `type`             | `boolean`                    | `false`  | If this import is a pure type import.                                                                           |
-| `typeFrom`         | `string`                     | `false`  | Use this as the `from` value when generating type declarations.                                                 |
-| `as`               | `string`                     | `false`  | Import as this name.                                                                                            |
+| Property   | Type                  | Required | Description                                                                                                     |
+|------------|-----------------------|----------|-----------------------------------------------------------------------------------------------------------------|
+| `name`     | `string`              | `true`   | Import name to be detected.                                                                                     |
+| `from`     | `string`              | `true`   | Module specifier to import from.                                                                                |
+| `priority` | `number`              | `false`  | Priority of the import; if multiple imports have the same name, the one with the highest priority will be used. |
+| `disabled` | `boolean`             | `false`  | If this import is disabled.                                                                                     |
+| `meta`     | `Record<string, any>` | `false`  | Metadata of the import.                                                                                         |
+| `type`     | `boolean`             | `false`  | If this import is a pure type import.                                                                           |
+| `typeFrom` | `string`              | `false`  | Use this as the `from` value when generating type declarations.                                                 |
+| `as`       | `string`              | `false`  | Import as this name.                                                                                            |
 
 ## `addImportsDir`
 
@@ -98,10 +98,10 @@ function addImportsDir (dirs: string | string[], options?: { prepend?: boolean }
 
 ### Parameters
 
-| Property           | Type                         | Required | Description                                                                                                     |
-| ------------------ | ---------------------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
-| `dirs`             | `string \| string[]`{lang="ts"}          | `true`   | A string or an array of strings with the path to the directory to import from.                                 |
-| `options`          | `{ prepend?: boolean }`{lang="ts"}      | `false`  | Options to pass to the import. If `prepend` is set to `true`, the imports will be prepended to the list of imports. |
+| Property  | Type                               | Required | Description                                                                                                         |
+|-----------|------------------------------------|----------|---------------------------------------------------------------------------------------------------------------------|
+| `dirs`    | `string \| string[]`{lang="ts"}    | `true`   | A string or an array of strings with the path to the directory to import from.                                      |
+| `options` | `{ prepend?: boolean }`{lang="ts"} | `false`  | Options to pass to the import. If `prepend` is set to `true`, the imports will be prepended to the list of imports. |
 
 ## `addImportsSources`
 
@@ -138,7 +138,7 @@ function addImportsSources (importSources: ImportSource | ImportSource[]): void
 
 **importSources**: An object or an array of objects with the following properties:
 
-| Property           | Type                         | Required | Description                                                                                                     |
-| ------------------ | ---------------------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
-| `from`             | `string`                     | `true`   | Module specifier to import from.                                                                                |
-| `imports`          | `PresetImport \| ImportSource[]`{lang="ts"} | `true`   | An object or an array of objects, which can be import names, import objects or import sources.                  |
+| Property  | Type                                        | Required | Description                                                                                    |
+|-----------|---------------------------------------------|----------|------------------------------------------------------------------------------------------------|
+| `from`    | `string`                                    | `true`   | Module specifier to import from.                                                               |
+| `imports` | `PresetImport \| ImportSource[]`{lang="ts"} | `true`   | An object or an array of objects, which can be import names, import objects or import sources. |