@nuxt/docs 4.2.1 → 4.2.2

package/4.api/4.commands/generate.md

@@ -0,0 +1,42 @@
+---
+title: "nuxt generate"
+description: Pre-renders every route of the application and stores the result in plain HTML files.
+links:
+  - label: Source
+    icon: i-simple-icons-github
+    to: https://github.com/nuxt/cli/blob/main/packages/nuxi/src/commands/generate.ts
+    size: xs
+---
+
+<!--generate-cmd-->
+```bash [Terminal]
+npx nuxt generate [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--preset] [--dotenv] [--envName] [-e, --extends=<layer-name>]
+```
+<!--/generate-cmd-->
+
+The `generate` command pre-renders every route of your application and stores the result in plain HTML files that you can deploy on any static hosting services. The command triggers the `nuxt build` command with the `prerender` argument set to `true`
+
+## Arguments
+
+<!--generate-args-->
+| Argument      | Description                                    |
+|---------------|------------------------------------------------|
+| `ROOTDIR="."` | Specifies the working directory (default: `.`) |
+<!--/generate-args-->
+
+## Options
+
+<!--generate-opts-->
+| Option                               | Default | Description                                                                                                                                          |
+|--------------------------------------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `--cwd=<directory>`                  |         | Specify the working directory, this takes precedence over ROOTDIR (default: `.`)                                                                     |
+| `--logLevel=<silent\|info\|verbose>` |         | Specify build-time log level                                                                                                                         |
+| `--preset`                           |         | Nitro server preset                                                                                                                                  |
+| `--dotenv`                           |         | Path to `.env` file to load, relative to the root directory                                                                                          |
+| `--envName`                          |         | The environment to use when resolving configuration overrides (default is `production` when building, and `development` when running the dev server) |
+| `-e, --extends=<layer-name>`         |         | Extend from a Nuxt layer                                                                                                                             |
+<!--/generate-opts-->
+
+::read-more{to="/docs/4.x/getting-started/deployment#static-hosting"}
+Read more about pre-rendering and static hosting.
+::

package/4.api/4.commands/info.md

@@ -0,0 +1,33 @@
+---
+title: "nuxt info"
+description: The info command logs information about the current or specified Nuxt project.
+links:
+  - label: Source
+    icon: i-simple-icons-github
+    to: https://github.com/nuxt/cli/blob/main/packages/nuxi/src/commands/info.ts
+    size: xs
+---
+
+<!--info-cmd-->
+```bash [Terminal]
+npx nuxt info [ROOTDIR] [--cwd=<directory>]
+```
+<!--/info-cmd-->
+
+The `info` command logs information about the current or specified Nuxt project.
+
+## Arguments
+
+<!--info-args-->
+| Argument      | Description                                    |
+|---------------|------------------------------------------------|
+| `ROOTDIR="."` | Specifies the working directory (default: `.`) |
+<!--/info-args-->
+
+## Options
+
+<!--info-opts-->
+| Option              | Default | Description                                                                      |
+|---------------------|---------|----------------------------------------------------------------------------------|
+| `--cwd=<directory>` |         | Specify the working directory, this takes precedence over ROOTDIR (default: `.`) |
+<!--/info-opts-->

package/4.api/4.commands/init.md

@@ -0,0 +1,50 @@
+---
+title: "create nuxt"
+description: The init command initializes a fresh Nuxt project.
+links:
+  - label: Source
+    icon: i-simple-icons-github
+    to: https://github.com/nuxt/cli/blob/main/packages/nuxi/src/commands/init.ts
+    size: xs
+---
+
+<!--init-cmd-->
+```bash [Terminal]
+npm create nuxt@latest [DIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [-t, --template] [-f, --force] [--offline] [--preferOffline] [--no-install] [--gitInit] [--shell] [--packageManager] [-M, --modules] [--no-modules] [--nightly]
+```
+<!--/init-cmd-->
+
+The `create-nuxt` command initializes a fresh Nuxt project using [unjs/giget](https://github.com/unjs/giget).
+
+## Arguments
+
+<!--init-args-->
+| Argument | Description       |
+|----------|-------------------|
+| `DIR=""` | Project directory |
+<!--/init-args-->
+
+## Options
+
+<!--init-opts-->
+| Option                               | Default | Description                                              |
+|--------------------------------------|---------|----------------------------------------------------------|
+| `--cwd=<directory>`                  | `.`     | Specify the working directory                            |
+| `--logLevel=<silent\|info\|verbose>` |         | Specify build-time log level                             |
+| `-t, --template`                     |         | Template name                                            |
+| `-f, --force`                        |         | Override existing directory                              |
+| `--offline`                          |         | Force offline mode                                       |
+| `--preferOffline`                    |         | Prefer offline mode                                      |
+| `--no-install`                       |         | Skip installing dependencies                             |
+| `--gitInit`                          |         | Initialize git repository                                |
+| `--shell`                            |         | Start shell after installation in project directory      |
+| `--packageManager`                   |         | Package manager choice (npm, pnpm, yarn, bun)            |
+| `-M, --modules`                      |         | Nuxt modules to install (comma separated without spaces) |
+| `--no-modules`                       |         | Skip module installation prompt                          |
+| `--nightly`                          |         | Use Nuxt nightly release channel (3x or latest)          |
+<!--/init-opts-->
+
+## Environment variables
+
+- `NUXI_INIT_REGISTRY`: Set to a custom template registry. ([learn more](https://github.com/unjs/giget#custom-registry)).
+  - Default registry is loaded from [nuxt/starter/templates](https://github.com/nuxt/starter/tree/templates/templates)

package/4.api/4.commands/module.md

@@ -0,0 +1,84 @@
+---
+title: "nuxt module"
+description: "Search and add modules to your Nuxt application with the command line."
+links:
+  - label: Source
+    icon: i-simple-icons-github
+    to: https://github.com/nuxt/cli/tree/main/packages/nuxi/src/commands/module
+    size: xs
+---
+
+Nuxt provides a few utilities to work with [Nuxt modules](/modules) seamlessly.
+
+## nuxt module add
+
+<!--module-add-cmd-->
+```bash [Terminal]
+npx nuxt module add <MODULENAME> [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--skipInstall] [--skipConfig] [--dev]
+```
+<!--/module-add-cmd-->
+
+<!--module-add-args-->
+| Argument     | Description                                                         |
+|--------------|---------------------------------------------------------------------|
+| `MODULENAME` | Specify one or more modules to install by name, separated by spaces |
+<!--/module-add-args-->
+
+<!--module-add-opts-->
+| Option                               | Default | Description                         |
+|--------------------------------------|---------|-------------------------------------|
+| `--cwd=<directory>`                  | `.`     | Specify the working directory       |
+| `--logLevel=<silent\|info\|verbose>` |         | Specify build-time log level        |
+| `--skipInstall`                      |         | Skip npm install                    |
+| `--skipConfig`                       |         | Skip nuxt.config.ts update          |
+| `--dev`                              |         | Install modules as dev dependencies |
+<!--/module-add-opts-->
+
+The command lets you install [Nuxt modules](/modules) in your application with no manual work.
+
+When running the command, it will:
+
+- install the module as a dependency using your package manager
+- add it to your [package.json](/docs/4.x/directory-structure/package) file
+- update your [`nuxt.config`](/docs/4.x/directory-structure/nuxt-config) file
+
+**Example:**
+
+Installing the [`Pinia`](/modules/pinia) module
+
+```bash [Terminal]
+npx nuxt module add pinia
+```
+
+## nuxt module search
+
+<!--module-search-cmd-->
+```bash [Terminal]
+npx nuxt module search <QUERY> [--cwd=<directory>] [--nuxtVersion=<2|3>]
+```
+<!--/module-search-cmd-->
+
+### Arguments
+
+<!--module-search-args-->
+| Argument | Description            |
+|----------|------------------------|
+| `QUERY`  | keywords to search for |
+<!--/module-search-args-->
+
+### Options
+
+<!--module-search-opts-->
+| Option                 | Default | Description                                                                        |
+|------------------------|---------|------------------------------------------------------------------------------------|
+| `--cwd=<directory>`    | `.`     | Specify the working directory                                                      |
+| `--nuxtVersion=<2\|3>` |         | Filter by Nuxt version and list compatible modules only (auto detected by default) |
+<!--/module-search-opts-->
+
+The command searches for Nuxt modules matching your query that are compatible with your Nuxt version.
+
+**Example:**
+
+```bash [Terminal]
+npx nuxt module search pinia
+```

package/4.api/4.commands/prepare.md

@@ -0,0 +1,41 @@
+---
+title: 'nuxt prepare'
+description: The prepare command creates a .nuxt directory in your application and generates types.
+links:
+  - label: Source
+    icon: i-simple-icons-github
+    to: https://github.com/nuxt/cli/blob/main/packages/nuxi/src/commands/prepare.ts
+    size: xs
+---
+
+<!--prepare-cmd-->
+```bash [Terminal]
+npx nuxt prepare [ROOTDIR] [--dotenv] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--envName] [-e, --extends=<layer-name>]
+```
+<!--/prepare-cmd-->
+
+The `prepare` command creates a [`.nuxt`](/docs/4.x/directory-structure/nuxt) directory in your application and generates types. This can be useful in a CI environment or as a `postinstall` command in your [`package.json`](/docs/4.x/directory-structure/package).
+
+## Arguments
+
+<!--prepare-args-->
+| Argument      | Description                                    |
+|---------------|------------------------------------------------|
+| `ROOTDIR="."` | Specifies the working directory (default: `.`) |
+<!--/prepare-args-->
+
+## Options
+
+<!--prepare-opts-->
+| Option                               | Default | Description                                                                                                                                          |
+|--------------------------------------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `--dotenv`                           |         | Path to `.env` file to load, relative to the root directory                                                                                          |
+| `--cwd=<directory>`                  |         | Specify the working directory, this takes precedence over ROOTDIR (default: `.`)                                                                     |
+| `--logLevel=<silent\|info\|verbose>` |         | Specify build-time log level                                                                                                                         |
+| `--envName`                          |         | The environment to use when resolving configuration overrides (default is `production` when building, and `development` when running the dev server) |
+| `-e, --extends=<layer-name>`         |         | Extend from a Nuxt layer                                                                                                                             |
+<!--/prepare-opts-->
+
+::note
+This command sets `process.env.NODE_ENV` to `production`.
+::

package/4.api/4.commands/preview.md

@@ -0,0 +1,44 @@
+---
+title: "nuxt preview"
+description: The preview command starts a server to preview your application after the build command.
+links:
+  - label: Source
+    icon: i-simple-icons-github
+    to: https://github.com/nuxt/cli/blob/main/packages/nuxi/src/commands/preview.ts
+    size: xs
+---
+
+<!--preview-cmd-->
+```bash [Terminal]
+npx nuxt preview [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--envName] [-e, --extends=<layer-name>] [-p, --port] [--dotenv]
+```
+<!--/preview-cmd-->
+
+The `preview` command starts a server to preview your Nuxt application after running the `build` command. The `start` command is an alias for `preview`. When running your application in production refer to the [Deployment section](/docs/4.x/getting-started/deployment).
+
+## Arguments
+
+<!--preview-args-->
+| Argument      | Description                                    |
+|---------------|------------------------------------------------|
+| `ROOTDIR="."` | Specifies the working directory (default: `.`) |
+<!--/preview-args-->
+
+## Options
+
+<!--preview-opts-->
+| Option                               | Default | Description                                                                                                                                          |
+|--------------------------------------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `--cwd=<directory>`                  |         | Specify the working directory, this takes precedence over ROOTDIR (default: `.`)                                                                     |
+| `--logLevel=<silent\|info\|verbose>` |         | Specify build-time log level                                                                                                                         |
+| `--envName`                          |         | The environment to use when resolving configuration overrides (default is `production` when building, and `development` when running the dev server) |
+| `-e, --extends=<layer-name>`         |         | Extend from a Nuxt layer                                                                                                                             |
+| `-p, --port`                         |         | Port to listen on (use `PORT` environment variable to override)                                                                                      |
+| `--dotenv`                           |         | Path to `.env` file to load, relative to the root directory                                                                                          |
+<!--/preview-opts-->
+
+This command sets `process.env.NODE_ENV` to `production`. To override, define `NODE_ENV` in a `.env` file or as command-line argument.
+
+::note
+For convenience, in preview mode, your [`.env`](/docs/4.x/directory-structure/env) file will be loaded into `process.env`. (However, in production you will need to ensure your environment variables are set yourself. For example, with Node.js 20+ you could do this by running `node --env-file .env .output/server/index.mjs` to start your server.)
+::

package/4.api/4.commands/test.md

@@ -0,0 +1,40 @@
+---
+title: "nuxt test"
+description: The test command runs tests using @nuxt/test-utils.
+links:
+  - label: Source
+    icon: i-simple-icons-github
+    to: https://github.com/nuxt/cli/blob/main/packages/nuxi/src/commands/test.ts
+    size: xs
+---
+
+<!--test-cmd-->
+```bash [Terminal]
+npx nuxt test [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--dev] [--watch]
+```
+<!--/test-cmd-->
+
+The `test` command runs tests using [`@nuxt/test-utils`](/docs/getting-started/testing). This command sets `process.env.NODE_ENV` to `test` if not already set.
+
+## Arguments
+
+<!--test-args-->
+| Argument      | Description                                    |
+|---------------|------------------------------------------------|
+| `ROOTDIR="."` | Specifies the working directory (default: `.`) |
+<!--/test-args-->
+
+## Options
+
+<!--test-opts-->
+| Option                               | Default | Description                                                                      |
+|--------------------------------------|---------|----------------------------------------------------------------------------------|
+| `--cwd=<directory>`                  |         | Specify the working directory, this takes precedence over ROOTDIR (default: `.`) |
+| `--logLevel=<silent\|info\|verbose>` |         | Specify build-time log level                                                     |
+| `--dev`                              |         | Run in dev mode                                                                  |
+| `--watch`                            |         | Watch mode                                                                       |
+<!--/test-opts-->
+
+::note
+This command sets `process.env.NODE_ENV` to `test`.
+::

package/4.api/4.commands/typecheck.md

@@ -0,0 +1,44 @@
+---
+title: "nuxt typecheck"
+description: The typecheck command runs vue-tsc to check types throughout your app.
+links:
+  - label: Source
+    icon: i-simple-icons-github
+    to: https://github.com/nuxt/cli/blob/main/packages/nuxi/src/commands/typecheck.ts
+    size: xs
+---
+
+<!--typecheck-cmd-->
+```bash [Terminal]
+npx nuxt typecheck [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--dotenv] [-e, --extends=<layer-name>]
+```
+<!--/typecheck-cmd-->
+
+The `typecheck` command runs [`vue-tsc`](https://github.com/vuejs/language-tools/tree/master/packages/tsc) to check types throughout your app.
+
+## Arguments
+
+<!--typecheck-args-->
+| Argument      | Description                                    |
+|---------------|------------------------------------------------|
+| `ROOTDIR="."` | Specifies the working directory (default: `.`) |
+<!--/typecheck-args-->
+
+## Options
+
+<!--typecheck-opts-->
+| Option                               | Default | Description                                                                      |
+|--------------------------------------|---------|----------------------------------------------------------------------------------|
+| `--cwd=<directory>`                  |         | Specify the working directory, this takes precedence over ROOTDIR (default: `.`) |
+| `--logLevel=<silent\|info\|verbose>` |         | Specify build-time log level                                                     |
+| `--dotenv`                           |         | Path to `.env` file to load, relative to the root directory                      |
+| `-e, --extends=<layer-name>`         |         | Extend from a Nuxt layer                                                         |
+<!--/typecheck-opts-->
+
+::note
+This command sets `process.env.NODE_ENV` to `production`. To override, define `NODE_ENV` in a [`.env`](/docs/4.x/directory-structure/env) file or as a command-line argument.
+::
+
+::read-more{to="/docs/4.x/guide/concepts/typescript#type-checking"}
+Read more on how to enable type-checking at build or development time.
+::

package/4.api/4.commands/upgrade.md

@@ -0,0 +1,37 @@
+---
+title: "nuxt upgrade"
+description: The upgrade command upgrades Nuxt to the latest version.
+links:
+  - label: Source
+    icon: i-simple-icons-github
+    to: https://github.com/nuxt/cli/blob/main/packages/nuxi/src/commands/upgrade.ts
+    size: xs
+---
+
+<!--upgrade-cmd-->
+```bash [Terminal]
+npx nuxt upgrade [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--dedupe] [-f, --force] [-ch, --channel=<stable|nightly|v3|v4|v4-nightly|v3-nightly>]
+```
+<!--/upgrade-cmd-->
+
+The `upgrade` command upgrades Nuxt to the latest version.
+
+## Arguments
+
+<!--upgrade-args-->
+| Argument      | Description                                    |
+|---------------|------------------------------------------------|
+| `ROOTDIR="."` | Specifies the working directory (default: `.`) |
+<!--/upgrade-args-->
+
+## Options
+
+<!--upgrade-opts-->
+| Option                                                             | Default  | Description                                                                      |
+|--------------------------------------------------------------------|----------|----------------------------------------------------------------------------------|
+| `--cwd=<directory>`                                                |          | Specify the working directory, this takes precedence over ROOTDIR (default: `.`) |
+| `--logLevel=<silent\|info\|verbose>`                               |          | Specify build-time log level                                                     |
+| `--dedupe`                                                         |          | Dedupe dependencies after upgrading                                              |
+| `-f, --force`                                                      |          | Force upgrade to recreate lockfile and node_modules                              |
+| `-ch, --channel=<stable\|nightly\|v3\|v4\|v4-nightly\|v3-nightly>` | `stable` | Specify a channel to install from (default: stable)                              |
+<!--/upgrade-opts-->

package/{3.api → 4.api}/5.kit/1.modules.md

@@ -4,7 +4,7 @@ description: Nuxt Kit provides a set of utilities to help you create and use mod
 links:
   - label: Source
     icon: i-simple-icons-github
-    to: https://github.com/nuxt/nuxt/blob/main/packages/kit/src/module
+    to: https://github.com/nuxt/nuxt/tree/main/packages/kit/src/module
     size: xs
 ---
 
@@ -56,16 +56,16 @@ export function defineNuxtModule<TOptions extends ModuleOptions> (): {
 
 **definition**: A module definition object or a module function. The module definition object should contain the following properties:
 
-| Property           | Type                                                                 | Required | Description                                                                                                     |
-| ------------------ | -------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
-| `meta`             | `ModuleMeta`                                                         | `false`  | Metadata of the module. It defines the module name, version, config key and compatibility.                      |
-| `defaults`         | `T \| ((nuxt: Nuxt) => T)`{lang="ts"}                                | `false`  | Default options for the module. If a function is provided, it will be called with the Nuxt instance as the first argument. |
-| `schema`           | `T`                                                                  | `false`  | Schema for the module options. If provided, options will be applied to the schema.                              |
-| `hooks`            | `Partial<NuxtHooks>`{lang="ts"}                                      | `false`  | Hooks to be installed for the module. If provided, the module will install the hooks.                           |
-| `moduleDependencies` | `Record<string, ModuleDependency> \| ((nuxt: Nuxt) => Record<string, ModuleDependency>)`{lang="ts"} | `false`  | Dependencies on other modules with version constraints and configuration. Can be an object or a function that receives the Nuxt instance. See [example](/docs/4.x/api/kit/modules#specifying-module-dependencies). |
-| `onInstall`        | `(nuxt: Nuxt) => Awaitable<void>`{lang="ts"}                        | `false`  | Lifecycle hook called when the module is first installed. Requires `meta.name` and `meta.version` to be defined. |
-| `onUpgrade`        | `(options: T, nuxt: Nuxt, previousVersion: string) => Awaitable<void>`{lang="ts"} | `false`  | Lifecycle hook called when the module is upgraded to a newer version. Requires `meta.name` and `meta.version` to be defined. |
-| `setup`            | `(this: void, resolvedOptions: T, nuxt: Nuxt) => Awaitable<void \| false \| ModuleSetupInstallResult>`{lang="ts"} | `false`  | Setup function for the module. If provided, the module will call the setup function.    |
+| Property             | Type                                                                                                              | Required | Description                                                                                                                                                                                                        |
+|----------------------|-------------------------------------------------------------------------------------------------------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `meta`               | `ModuleMeta`                                                                                                      | `false`  | Metadata of the module. It defines the module name, version, config key and compatibility.                                                                                                                         |
+| `defaults`           | `T \| ((nuxt: Nuxt) => T)`{lang="ts"}                                                                             | `false`  | Default options for the module. If a function is provided, it will be called with the Nuxt instance as the first argument.                                                                                         |
+| `schema`             | `T`                                                                                                               | `false`  | Schema for the module options. If provided, options will be applied to the schema.                                                                                                                                 |
+| `hooks`              | `Partial<NuxtHooks>`{lang="ts"}                                                                                   | `false`  | Hooks to be installed for the module. If provided, the module will install the hooks.                                                                                                                              |
+| `moduleDependencies` | `Record<string, ModuleDependency> \| ((nuxt: Nuxt) => Record<string, ModuleDependency>)`{lang="ts"}               | `false`  | Dependencies on other modules with version constraints and configuration. Can be an object or a function that receives the Nuxt instance. See [example](/docs/4.x/api/kit/modules#specifying-module-dependencies). |
+| `onInstall`          | `(nuxt: Nuxt) => Awaitable<void>`{lang="ts"}                                                                      | `false`  | Lifecycle hook called when the module is first installed. Requires `meta.name` and `meta.version` to be defined.                                                                                                   |
+| `onUpgrade`          | `(options: T, nuxt: Nuxt, previousVersion: string) => Awaitable<void>`{lang="ts"}                                 | `false`  | Lifecycle hook called when the module is upgraded to a newer version. Requires `meta.name` and `meta.version` to be defined.                                                                                       |
+| `setup`              | `(this: void, resolvedOptions: T, nuxt: Nuxt) => Awaitable<void \| false \| ModuleSetupInstallResult>`{lang="ts"} | `false`  | Setup function for the module. If provided, the module will call the setup function.                                                                                                                               |
 
 ### Examples
 
@@ -359,11 +359,11 @@ async function installModule (moduleToInstall: string | NuxtModule, inlineOption
 
 ### Parameters
 
-| Property           | Type                                         | Required | Description                                                                                                     |
-| ------------------ | -------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
-| `moduleToInstall`  | `string \| NuxtModule`{lang="ts"}            | `true`   | The module to install. Can be either a string with the module name or a module object itself.                   |
-| `inlineOptions`    | `any`                                        | `false`  | An object with the module options to be passed to the module's `setup` function.                                |
-| `nuxt`             | `Nuxt`                                       | `false`  | Nuxt instance. If not provided, it will be retrieved from the context via `useNuxt()` call.                     |
+| Property          | Type                              | Required | Description                                                                                   |
+|-------------------|-----------------------------------|----------|-----------------------------------------------------------------------------------------------|
+| `moduleToInstall` | `string \| NuxtModule`{lang="ts"} | `true`   | The module to install. Can be either a string with the module name or a module object itself. |
+| `inlineOptions`   | `any`                             | `false`  | An object with the module options to be passed to the module's `setup` function.              |
+| `nuxt`            | `Nuxt`                            | `false`  | Nuxt instance. If not provided, it will be retrieved from the context via `useNuxt()` call.   |
 
 ### Examples
 

package/{3.api → 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. |