@nuxt/docs 3.20.2 → 3.21.0

package/4.api/4.commands/cleanup.md

@@ -24,15 +24,15 @@ The `cleanup` command removes common generated Nuxt files and caches, including:
 ## Arguments
 
 <!--cleanup-args-->
-Argument | Description
---- | ---
-`ROOTDIR="."` | Specifies the working directory (default: `.`)
+| Argument      | Description                                    |
+|---------------|------------------------------------------------|
+| `ROOTDIR="."` | Specifies the working directory (default: `.`) |
 <!--/cleanup-args-->
 
 ## Options
 
 <!--cleanup-opts-->
-Option | Default | Description
---- | --- | ---
-`--cwd=<directory>` |  | Specify the working directory, this takes precedence over ROOTDIR (default: `.`)
+| Option              | Default | Description                                                                      |
+|---------------------|---------|----------------------------------------------------------------------------------|
+| `--cwd=<directory>` |         | Specify the working directory, this takes precedence over ROOTDIR (default: `.`) |
 <!--/cleanup-opts-->

package/4.api/4.commands/dev.md

@@ -19,34 +19,34 @@ The `dev` command starts a development server with hot module replacement at [ht
 ## Arguments
 
 <!--dev-args-->
-Argument | Description
---- | ---
-`ROOTDIR="."` | Specifies the working directory (default: `.`)
+| Argument      | Description                                    |
+|---------------|------------------------------------------------|
+| `ROOTDIR="."` | Specifies the working directory (default: `.`) |
 <!--/dev-args-->
 
 ## Options
 
 <!--dev-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
-`--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
-`--clear` | `false` | Clear console on restart
-`--no-f, --no-fork` |  | Disable forked mode
-`-p, --port` |  | Port to listen on (default: `NUXT_PORT \|\| NITRO_PORT \|\| PORT \|\| nuxtOptions.devServer.port`)
-`-h, --host` |  | Host to listen on (default: `NUXT_HOST \|\| NITRO_HOST \|\| HOST \|\| nuxtOptions.devServer?.host`)
-`--clipboard` | `false` | Copy the URL to the clipboard
-`-o, --open` | `false` | Open the URL in the browser
-`--https` |  | Enable HTTPS
-`--publicURL` |  | Displayed public URL (used for QR code)
-`--qr` |  | Display The QR code of public URL when available
-`--public` |  | Listen to all network interfaces
-`--tunnel` |  | Open a tunnel using https://github.com/unjs/untun
-`--sslCert` |  | (DEPRECATED) Use `--https.cert` instead.
-`--sslKey` |  | (DEPRECATED) Use `--https.key` instead.
+| 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                                                                                          |
+| `--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                                                                                                                             |
+| `--clear`                            | `false` | Clear console on restart                                                                                                                             |
+| `--no-f, --no-fork`                  |         | Disable forked mode                                                                                                                                  |
+| `-p, --port`                         |         | Port to listen on (default: `NUXT_PORT \|\| NITRO_PORT \|\| PORT \|\| nuxtOptions.devServer.port`)                                                   |
+| `-h, --host`                         |         | Host to listen on (default: `NUXT_HOST \|\| NITRO_HOST \|\| HOST \|\| nuxtOptions.devServer?.host`)                                                  |
+| `--clipboard`                        | `false` | Copy the URL to the clipboard                                                                                                                        |
+| `-o, --open`                         | `false` | Open the URL in the browser                                                                                                                          |
+| `--https`                            |         | Enable HTTPS                                                                                                                                         |
+| `--publicURL`                        |         | Displayed public URL (used for QR code)                                                                                                              |
+| `--qr`                               |         | Display The QR code of public URL when available                                                                                                     |
+| `--public`                           |         | Listen to all network interfaces                                                                                                                     |
+| `--tunnel`                           |         | Open a tunnel using https://github.com/unjs/untun                                                                                                    |
+| `--sslCert`                          |         | (DEPRECATED) Use `--https.cert` instead.                                                                                                             |
+| `--sslKey`                           |         | (DEPRECATED) Use `--https.key` instead.                                                                                                              |
 <!--/dev-opts-->
 
 The port and host can also be set via NUXT_PORT, PORT, NUXT_HOST or HOST environment variables.

package/4.api/4.commands/devtools.md

@@ -19,18 +19,18 @@ Running `nuxt devtools enable` will install the Nuxt DevTools globally, and also
 ## Arguments
 
 <!--devtools-args-->
-Argument | Description
---- | ---
-`COMMAND` | Command to run (options: <enable\|disable>)
-`ROOTDIR="."` | Specifies the working directory (default: `.`)
+| Argument      | Description                                    |
+|---------------|------------------------------------------------|
+| `COMMAND`     | Command to run (options: <enable\|disable>)    |
+| `ROOTDIR="."` | Specifies the working directory (default: `.`) |
 <!--/devtools-args-->
 
 ## Options
 
 <!--devtools-opts-->
-Option | Default | Description
---- | --- | ---
-`--cwd=<directory>` |  | Specify the working directory, this takes precedence over ROOTDIR (default: `.`)
+| Option              | Default | Description                                                                      |
+|---------------------|---------|----------------------------------------------------------------------------------|
+| `--cwd=<directory>` |         | Specify the working directory, this takes precedence over ROOTDIR (default: `.`) |
 <!--/devtools-opts-->
 
 ::read-more{icon="i-simple-icons-nuxtdotjs" to="https://devtools.nuxt.com" target="\_blank"}

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

@@ -19,24 +19,24 @@ The `generate` command pre-renders every route of your application and stores th
 ## Arguments
 
 <!--generate-args-->
-Argument | Description
---- | ---
-`ROOTDIR="."` | Specifies the working directory (default: `.`)
+| 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
+| 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/getting-started/deployment#static-hosting"}
+::read-more{to="/docs/3.x/getting-started/deployment#static-hosting"}
 Read more about pre-rendering and static hosting.
 ::

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

@@ -19,15 +19,15 @@ The `info` command logs information about the current or specified Nuxt project.
 ## Arguments
 
 <!--info-args-->
-Argument | Description
---- | ---
-`ROOTDIR="."` | Specifies the working directory (default: `.`)
+| 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: `.`)
+| Option              | Default | Description                                                                      |
+|---------------------|---------|----------------------------------------------------------------------------------|
+| `--cwd=<directory>` |         | Specify the working directory, this takes precedence over ROOTDIR (default: `.`) |
 <!--/info-opts-->

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

@@ -19,29 +19,29 @@ The `create-nuxt` command initializes a fresh Nuxt project using [unjs/giget](ht
 ## Arguments
 
 <!--init-args-->
-Argument | Description
---- | ---
-`DIR=""` | Project directory
+| 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)
+| 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

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

@@ -4,7 +4,7 @@ description: "Search and add modules to your Nuxt application with the command l
 links:
   - label: Source
     icon: i-simple-icons-github
-    to: https://github.com/nuxt/cli/blob/main/packages/nuxi/src/commands/module/
+    to: https://github.com/nuxt/cli/tree/main/packages/nuxi/src/commands/module
     size: xs
 ---
 
@@ -19,19 +19,19 @@ npx nuxt module add <MODULENAME> [--cwd=<directory>] [--logLevel=<silent|info|ve
 <!--/module-add-cmd-->
 
 <!--module-add-args-->
-Argument | Description
---- | ---
-`MODULENAME` | Specify one or more modules to install by name, separated by spaces
+| 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
+| 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.
@@ -61,18 +61,18 @@ npx nuxt module search <QUERY> [--cwd=<directory>] [--nuxtVersion=<2|3>]
 ### Arguments
 
 <!--module-search-args-->
-Argument | Description
---- | ---
-`QUERY` | keywords to search for
+| 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)
+| 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.

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

@@ -19,21 +19,21 @@ The `prepare` command creates a [`.nuxt`](/docs/3.x/directory-structure/nuxt) di
 ## Arguments
 
 <!--prepare-args-->
-Argument | Description
---- | ---
-`ROOTDIR="."` | Specifies the working directory (default: `.`)
+| 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
+| 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

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

@@ -19,22 +19,22 @@ The `preview` command starts a server to preview your Nuxt application after run
 ## Arguments
 
 <!--preview-args-->
-Argument | Description
---- | ---
-`ROOTDIR="."` | Specifies the working directory (default: `.`)
+| 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
+| 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.

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

@@ -19,20 +19,20 @@ The `test` command runs tests using [`@nuxt/test-utils`](/docs/getting-started/t
 ## Arguments
 
 <!--test-args-->
-Argument | Description
---- | ---
-`ROOTDIR="."` | Specifies the working directory (default: `.`)
+| 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
+| 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

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

@@ -19,26 +19,26 @@ The `typecheck` command runs [`vue-tsc`](https://github.com/vuejs/language-tools
 ## Arguments
 
 <!--typecheck-args-->
-Argument | Description
---- | ---
-`ROOTDIR="."` | Specifies the working directory (default: `.`)
+| 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
+| 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/3.x/directory-structure/env) file or as a command-line argument.
 ::
 
-::read-more{to="/docs/guide/concepts/typescript#type-checking"}
+::read-more{to="/docs/3.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

@@ -19,19 +19,19 @@ The `upgrade` command upgrades Nuxt to the latest version.
 ## Arguments
 
 <!--upgrade-args-->
-Argument | Description
---- | ---
-`ROOTDIR="."` | Specifies the working directory (default: `.`)
+| 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)
+| 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/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](#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/3.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`          | `(nuxt: Nuxt, options: T, 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
 
@@ -103,6 +103,19 @@ export default defineNuxtConfig({
 })
 ```
 
+Users can also completely disable a module by setting the config key to `false`. This prevents the module's setup function from running while still generating types for module options.
+
+```ts
+export default defineNuxtConfig({
+  // Disable the module entirely
+  myModule: false,
+})
+```
+
+::tip
+This is particularly useful when you want to disable modules inherited from [Nuxt layers](/docs/3.x/guide/going-further/layers#disabling-modules-from-layers).
+::
+
 #### Defining Module Compatibility Requirements
 
 If you're developing a Nuxt module and using APIs that are only supported in specific Nuxt versions, it's highly recommended to include `compatibility.nuxt`.
@@ -216,7 +229,7 @@ export default defineNuxtModule({
     // - Perform initial data migration
   },
 
-  onUpgrade (options, nuxt, previousVersion) {
+  onUpgrade (nuxt, options, previousVersion) {
     // This runs when the module is upgraded to a newer version
     console.log(`Upgrading my-awesome-module from ${previousVersion} to 1.2.0`)
 
@@ -324,7 +337,7 @@ export default defineNuxtModule({
 ## `installModule`
 
 ::callout{type="warning"}
-**Deprecated:** Use the [`moduleDependencies`](#specifying-module-dependencies) option in `defineNuxtModule` instead. The `installModule` function will be removed (or may become non-blocking) in a future version.
+**Deprecated:** Use the [`moduleDependencies`](/docs/3.x/api/kit/modules#specifying-module-dependencies) option in `defineNuxtModule` instead. The `installModule` function will be removed (or may become non-blocking) in a future version.
 ::
 
 Install specified Nuxt module programmatically. This is helpful when your module depends on other modules. You can pass the module options as an object to `inlineOptions` and they will be passed to the module's `setup` function.
@@ -359,11 +372,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