npm - @nuxt/docs - Versions diffs - 3.19.2 → 3.20.0 - Mend

@nuxt/docs 3.19.2 → 3.20.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (192) hide show

package/1.getting-started/01.introduction.md +2 -2
package/1.getting-started/02.installation.md +2 -1
package/1.getting-started/03.configuration.md +29 -29
package/1.getting-started/04.views.md +7 -7
package/1.getting-started/05.assets.md +15 -9
package/1.getting-started/06.styling.md +55 -45
package/1.getting-started/07.routing.md +12 -12
package/1.getting-started/08.seo-meta.md +55 -42
package/1.getting-started/09.transitions.md +47 -42
package/1.getting-started/10.data-fetching.md +90 -67
package/1.getting-started/11.state-management.md +22 -15
package/1.getting-started/12.error-handling.md +11 -9
package/1.getting-started/13.server.md +3 -3
package/1.getting-started/14.layers.md +21 -15
package/1.getting-started/15.prerendering.md +28 -28
package/1.getting-started/16.deployment.md +9 -9
package/1.getting-started/17.testing.md +43 -43
package/1.getting-started/18.upgrade.md +66 -61
package/2.guide/0.index.md +3 -3
package/2.guide/{2.directory-structure → 1.directory-structure}/.navigation.yml +1 -1
package/2.guide/{2.directory-structure → 1.directory-structure}/0.nuxt.md +3 -3
package/2.guide/{2.directory-structure → 1.directory-structure}/0.output.md +3 -3
package/2.guide/{2.directory-structure → 1.directory-structure}/1.assets.md +3 -3
package/2.guide/{2.directory-structure → 1.directory-structure}/1.components.md +41 -24
package/2.guide/{2.directory-structure → 1.directory-structure}/1.composables.md +11 -11
package/2.guide/{2.directory-structure → 1.directory-structure}/1.content.md +7 -4
package/2.guide/{2.directory-structure → 1.directory-structure}/1.layouts.md +16 -12
package/2.guide/{2.directory-structure → 1.directory-structure}/1.middleware.md +28 -22
package/2.guide/{2.directory-structure → 1.directory-structure}/1.modules.md +6 -6
package/2.guide/{2.directory-structure → 1.directory-structure}/1.node_modules.md +2 -2
package/2.guide/{2.directory-structure → 1.directory-structure}/1.pages.md +33 -31
package/2.guide/{2.directory-structure → 1.directory-structure}/1.plugins.md +25 -25
package/2.guide/{2.directory-structure → 1.directory-structure}/1.public.md +2 -2
package/2.guide/{2.directory-structure → 1.directory-structure}/1.server.md +34 -34
package/2.guide/{2.directory-structure → 1.directory-structure}/1.shared.md +6 -6
package/2.guide/{2.directory-structure → 1.directory-structure}/1.utils.md +5 -5
package/2.guide/{2.directory-structure → 1.directory-structure}/2.env.md +5 -5
package/2.guide/{2.directory-structure → 1.directory-structure}/2.gitignore.md +1 -1
package/2.guide/{2.directory-structure → 1.directory-structure}/2.nuxtignore.md +4 -4
package/2.guide/{2.directory-structure → 1.directory-structure}/2.nuxtrc.md +3 -3
package/2.guide/{2.directory-structure → 1.directory-structure}/3.app-config.md +12 -12
package/2.guide/{2.directory-structure → 1.directory-structure}/3.app.md +4 -4
package/2.guide/{2.directory-structure → 1.directory-structure}/3.error.md +6 -6
package/2.guide/{2.directory-structure → 1.directory-structure}/3.nuxt-config.md +2 -2
package/2.guide/{2.directory-structure → 1.directory-structure}/3.package.md +1 -1
package/2.guide/{2.directory-structure → 1.directory-structure}/3.tsconfig.md +3 -3
package/2.guide/{1.concepts → 2.concepts}/1.auto-imports.md +18 -18
package/2.guide/{1.concepts → 2.concepts}/10.nuxt-lifecycle.md +10 -10
package/2.guide/{1.concepts → 2.concepts}/2.vuejs-development.md +9 -9
package/2.guide/{1.concepts → 2.concepts}/3.rendering.md +21 -19
package/2.guide/{1.concepts → 2.concepts}/4.server-engine.md +5 -5
package/2.guide/{1.concepts → 2.concepts}/5.modules.md +4 -4
package/2.guide/{1.concepts → 2.concepts}/7.esm.md +20 -14
package/2.guide/{1.concepts → 2.concepts}/8.typescript.md +11 -11
package/2.guide/3.going-further/1.events.md +2 -2
package/2.guide/3.going-further/1.experimental-features.md +168 -80
package/2.guide/3.going-further/1.features.md +15 -15
package/2.guide/3.going-further/1.internals.md +25 -25
package/2.guide/3.going-further/10.runtime-config.md +11 -11
package/2.guide/3.going-further/2.hooks.md +11 -11
package/2.guide/3.going-further/3.modules.md +119 -101
package/2.guide/3.going-further/4.kit.md +5 -5
package/2.guide/3.going-further/6.nuxt-app.md +5 -5
package/2.guide/3.going-further/7.layers.md +75 -58
package/2.guide/3.going-further/9.debugging.md +2 -2
package/2.guide/4.recipes/1.custom-routing.md +31 -31
package/2.guide/4.recipes/2.vite-plugin.md +45 -4
package/2.guide/4.recipes/3.custom-usefetch.md +12 -12
package/2.guide/4.recipes/4.sessions-and-authentication.md +34 -20
package/2.guide/5.best-practices/hydration.md +4 -4
package/2.guide/5.best-practices/performance.md +12 -12
package/3.api/1.components/1.client-only.md +6 -3
package/3.api/1.components/1.nuxt-client-fallback.md +9 -6
package/3.api/1.components/10.nuxt-picture.md +1 -1
package/3.api/1.components/11.teleports.md +4 -1
package/3.api/1.components/12.nuxt-route-announcer.md +9 -9
package/3.api/1.components/13.nuxt-time.md +49 -18
package/3.api/1.components/2.nuxt-page.md +4 -4
package/3.api/1.components/3.nuxt-layout.md +11 -6
package/3.api/1.components/4.nuxt-link.md +40 -20
package/3.api/1.components/5.nuxt-loading-indicator.md +2 -2
package/3.api/1.components/6.nuxt-error-boundary.md +11 -9
package/3.api/2.composables/on-prehydrate.md +2 -2
package/3.api/2.composables/use-async-data.md +23 -19
package/3.api/2.composables/use-cookie.md +28 -20
package/3.api/2.composables/use-error.md +1 -1
package/3.api/2.composables/use-fetch.md +59 -29
package/3.api/2.composables/use-head-safe.md +7 -7
package/3.api/2.composables/use-head.md +4 -4
package/3.api/2.composables/use-hydration.md +6 -6
package/3.api/2.composables/use-lazy-async-data.md +2 -2
package/3.api/2.composables/use-lazy-fetch.md +2 -2
package/3.api/2.composables/use-loading-indicator.md +12 -12
package/3.api/2.composables/use-nuxt-app.md +19 -19
package/3.api/2.composables/use-nuxt-data.md +8 -8
package/3.api/2.composables/use-preview-mode.md +15 -18
package/3.api/2.composables/use-request-event.md +1 -1
package/3.api/2.composables/use-request-fetch.md +3 -3
package/3.api/2.composables/use-request-header.md +1 -1
package/3.api/2.composables/use-request-headers.md +4 -4
package/3.api/2.composables/use-request-url.md +1 -1
package/3.api/2.composables/use-response-header.md +9 -10
package/3.api/2.composables/use-route-announcer.md +4 -4
package/3.api/2.composables/use-route.md +1 -1
package/3.api/2.composables/use-router.md +9 -7
package/3.api/2.composables/use-runtime-config.md +6 -6
package/3.api/2.composables/use-runtime-hook.md +2 -2
package/3.api/2.composables/use-seo-meta.md +2 -2
package/3.api/2.composables/use-server-seo-meta.md +4 -4
package/3.api/2.composables/use-state.md +4 -4
package/3.api/3.utils/$fetch.md +9 -7
package/3.api/3.utils/abort-navigation.md +3 -3
package/3.api/3.utils/add-route-middleware.md +5 -5
package/3.api/3.utils/call-once.md +4 -4
package/3.api/3.utils/clear-error.md +2 -2
package/3.api/3.utils/clear-nuxt-data.md +3 -3
package/3.api/3.utils/clear-nuxt-state.md +3 -3
package/3.api/3.utils/create-error.md +1 -1
package/3.api/3.utils/define-lazy-hydration-component.md +13 -13
package/3.api/3.utils/define-nuxt-component.md +5 -5
package/3.api/3.utils/define-nuxt-plugin.md +12 -12
package/3.api/3.utils/define-nuxt-route-middleware.md +5 -5
package/3.api/3.utils/define-page-meta.md +21 -21
package/3.api/3.utils/define-route-rules.md +5 -5
package/3.api/3.utils/navigate-to.md +10 -10
package/3.api/3.utils/prefetch-components.md +1 -1
package/3.api/3.utils/preload-components.md +1 -1
package/3.api/3.utils/prerender-routes.md +3 -3
package/3.api/3.utils/refresh-cookie.md +3 -3
package/3.api/3.utils/refresh-nuxt-data.md +11 -6
package/3.api/3.utils/reload-nuxt-app.md +2 -2
package/3.api/3.utils/set-page-layout.md +1 -1
package/3.api/3.utils/set-response-status.md +2 -2
package/3.api/3.utils/show-error.md +4 -4
package/3.api/3.utils/update-app-config.md +3 -2
package/3.api/4.commands/add.md +1 -1
package/3.api/4.commands/analyze.md +2 -1
package/3.api/4.commands/build.md +2 -1
package/3.api/4.commands/dev.md +5 -4
package/3.api/4.commands/generate.md +2 -1
package/3.api/4.commands/init.md +3 -2
package/3.api/4.commands/module.md +4 -4
package/3.api/4.commands/prepare.md +7 -2
package/3.api/4.commands/preview.md +5 -4
package/3.api/4.commands/test.md +40 -0
package/3.api/4.commands/typecheck.md +4 -2
package/3.api/4.commands/upgrade.md +3 -3
package/3.api/5.kit/1.modules.md +123 -37
package/3.api/5.kit/10.runtime-config.md +1 -1
package/3.api/5.kit/10.templates.md +8 -6
package/3.api/5.kit/11.nitro.md +66 -62
package/3.api/5.kit/12.resolving.md +2 -2
package/3.api/5.kit/14.builder.md +61 -4
package/3.api/5.kit/15.examples.md +5 -7
package/3.api/5.kit/16.layers.md +26 -26
package/3.api/5.kit/3.compatibility.md +12 -12
package/3.api/5.kit/4.autoimports.md +13 -13
package/3.api/5.kit/5.components.md +8 -7
package/3.api/5.kit/6.context.md +3 -3
package/3.api/5.kit/7.pages.md +7 -7
package/3.api/5.kit/8.layout.md +2 -2
package/3.api/5.kit/9.head.md +132 -0
package/3.api/5.kit/9.plugins.md +6 -5
package/3.api/6.advanced/1.hooks.md +4 -4
package/3.api/6.advanced/2.import-meta.md +3 -3
package/5.community/2.getting-help.md +1 -1
package/5.community/3.reporting-bugs.md +1 -1
package/5.community/4.contribution.md +6 -6
package/5.community/5.framework-contribution.md +3 -3
package/5.community/6.roadmap.md +1 -1
package/6.bridge/1.overview.md +13 -13
package/6.bridge/10.configuration.md +2 -1
package/6.bridge/2.typescript.md +2 -2
package/6.bridge/3.bridge-composition-api.md +6 -6
package/6.bridge/4.plugins-and-middleware.md +9 -9
package/6.bridge/5.nuxt3-compatible-api.md +19 -16
package/6.bridge/6.meta.md +20 -19
package/6.bridge/7.runtime-config.md +1 -1
package/6.bridge/8.nitro.md +3 -3
package/6.bridge/9.vite.md +4 -4
package/7.migration/1.overview.md +2 -2
package/7.migration/2.configuration.md +22 -20
package/7.migration/20.module-authors.md +6 -6
package/7.migration/3.auto-imports.md +3 -3
package/7.migration/4.meta.md +20 -17
package/7.migration/5.plugins-and-middleware.md +5 -5
package/7.migration/6.pages-and-layouts.md +23 -19
package/7.migration/7.component-options.md +14 -14
package/7.migration/8.runtime-config.md +6 -6
package/package.json +1 -1
/package/2.guide/{1.concepts → 2.concepts}/.navigation.yml +0 -0
/package/2.guide/{1.concepts → 2.concepts}/9.code-style.md +0 -0

package/3.api/5.kit/9.head.md ADDED Viewed

@@ -0,0 +1,132 @@
+---
+title: Head
+description: Nuxt Kit provides utilities to help you manage head configuration in modules.
+links:
+  - label: Source
+    icon: i-simple-icons-github
+    to: https://github.com/nuxt/nuxt/blob/main/packages/kit/src/head.ts
+    size: xs
+---
+## `setGlobalHead`
+Sets global head configuration for your Nuxt application. This utility allows modules to programmatically configure meta tags, links, scripts, and other head elements that will be applied across all pages.
+The provided head configuration will be merged with any existing head configuration using deep merging, with your provided values taking precedence.
+::tip
+This is particularly useful for modules that need to inject global meta tags, stylesheets, or scripts into the application head.
+::
+### Type
+```ts twoslash
+// @errors: 2391
+// ---cut---
+import type { SerializableHead } from '@unhead/vue/types'
+interface AppHeadMetaObject extends SerializableHead {
+  charset?: string
+  viewport?: string
+}
+function setGlobalHead (head: AppHeadMetaObject): void
+```
+### Parameters
+#### `head`
+**Type**: `AppHeadMetaObject`
+An object containing head configuration. All properties are optional and will be merged with existing configuration:
+- `charset`: Character encoding for the document
+- `viewport`: Viewport meta tag configuration
+- `meta`: Array of meta tag objects
+- `link`: Array of link tag objects (stylesheets, icons, etc.)
+- `style`: Array of inline style tag objects
+- `script`: Array of script tag objects
+- `noscript`: Array of noscript tag objects
+- `title`: Default page title
+- `titleTemplate`: Template for formatting page titles
+- `bodyAttrs`: Attributes to add to the `<body>` tag
+- `htmlAttrs`: Attributes to add to the `<html>` tag
+### Examples
+#### Adding Global Meta Tags
+```ts
+import { defineNuxtModule, setGlobalHead } from '@nuxt/kit'
+export default defineNuxtModule({
+  setup () {
+    setGlobalHead({
+      meta: [
+        { name: 'theme-color', content: '#ffffff' },
+        { name: 'author', content: 'Your Name' },
+      ],
+    })
+  },
+})
+```
+#### Injecting Global Stylesheets
+```ts
+import { defineNuxtModule, setGlobalHead } from '@nuxt/kit'
+export default defineNuxtModule({
+  setup () {
+    setGlobalHead({
+      link: [
+        {
+          rel: 'stylesheet',
+          href: 'https://fonts.googleapis.com/css2?family=Inter:wght@400;700&display=swap',
+        },
+      ],
+    })
+  },
+})
+```
+#### Adding Global Scripts
+```ts
+import { defineNuxtModule, setGlobalHead } from '@nuxt/kit'
+export default defineNuxtModule({
+  setup () {
+    setGlobalHead({
+      script: [
+        {
+          src: 'https://cdn.example.com/analytics.js',
+          async: true,
+          defer: true,
+        },
+      ],
+    })
+  },
+})
+```
+#### Setting HTML Attributes
+```ts
+import { defineNuxtModule, setGlobalHead } from '@nuxt/kit'
+export default defineNuxtModule({
+  setup () {
+    setGlobalHead({
+      htmlAttrs: {
+        lang: 'en',
+        dir: 'ltr',
+      },
+      bodyAttrs: {
+        class: 'custom-body-class',
+      },
+    })
+  },
+})
+```

package/3.api/5.kit/9.plugins.md CHANGED Viewed

@@ -38,7 +38,7 @@ export default defineNuxtModule({
 ### Type
 ```ts
-function addPlugin(plugin: NuxtPlugin | string, options?: AddPluginOptions): NuxtPlugin
+function addPlugin (plugin: NuxtPlugin | string, options?: AddPluginOptions): NuxtPlugin
 ```
 ### Parameters
@@ -128,7 +128,7 @@ export default defineNuxtPlugin({
 ### Type
 ```ts
-function addPluginTemplate(pluginOptions: NuxtPluginTemplate, options?: AddPluginOptions): NuxtPlugin
+function addPluginTemplate (pluginOptions: NuxtPluginTemplate, options?: AddPluginOptions): NuxtPlugin
 ```
 ### Parameters
@@ -204,12 +204,13 @@ export default defineNuxtConfig({
 ```ts [#build/vue-app-config.mjs]
 import { defineNuxtPlugin } from '#app/nuxt'
 export default defineNuxtPlugin({
   name: 'nuxt:vue-app-config',
   enforce: 'pre',
   setup (nuxtApp) {
-    nuxtApp.vueApp.config["idPrefix"] = "nuxt"
-  }
+    nuxtApp.vueApp.config.idPrefix = 'nuxt'
+  },
 })
 ```
@@ -239,7 +240,7 @@ export default defineNuxtModule({
 })
 ```
-```ts [templates/plugin.ejs]
+```ejs [templates/plugin.ejs]
 import { VueFire, useSSRInitialState } from 'vuefire'
 import { defineNuxtPlugin } from '#imports'

package/3.api/6.advanced/1.hooks.md CHANGED Viewed

@@ -30,7 +30,7 @@ Hook                   | Arguments           | Environment     | Description
 `page:loading:end`     | -                   | Client          | Called after `page:finish`
 `page:transition:finish`| `pageComponent?`    | Client          | After page transition [onAfterLeave](https://vuejs.org/guide/built-ins/transition.html#javascript-hooks) event.
 `dev:ssr-logs`         | `logs`              | Client          | Called with an array of server-side logs that have been passed to the client (if `features.devLogs` is enabled).
-`page:view-transition:start` | `transition`        | Client          | Called after `document.startViewTransition` is called when [experimental viewTransition support is enabled](/docs/getting-started/transitions#view-transitions-api-experimental).
+`page:view-transition:start` | `transition`        | Client          | Called after `document.startViewTransition` is called when [experimental viewTransition support is enabled](/docs/3.x/getting-started/transitions#view-transitions-api-experimental).
 ## Nuxt Hooks (build time)
@@ -46,7 +46,7 @@ Hook                     | Arguments                  | Description
 `modules:done`           | -                          | Called during Nuxt initialization, after installing user modules.
 `app:resolve`            | `app`                      | Called after resolving the `app` instance.
 `app:templates`          | `app`                      | Called during `NuxtApp` generation, to allow customizing, modifying or adding new files to the build directory (either virtually or to written to `.nuxt`).
-`app:templatesGenerated` | `app`                      | Called after templates are compiled into the [virtual file system](/docs/guide/directory-structure/nuxt#virtual-file-system) (vfs).
+`app:templatesGenerated` | `app`                      | Called after templates are compiled into the [virtual file system](/docs/3.x/guide/directory-structure/nuxt#virtual-file-system) (vfs).
 `build:before`           | -                          | Called before Nuxt bundle builder.
 `build:done`             | -                          | Called after Nuxt bundle builder is complete.
 `build:manifest`         | `manifest`                 | Called during the manifest build by Vite and webpack. This allows customizing the manifest that Nitro will use to render `<script>` and `<link>` tags in the final HTML.
@@ -75,8 +75,8 @@ Hook                     | Arguments                  | Description
 `schema:beforeWrite`     | `schema`                   | Called before writing the given schema.
 `schema:written`         | -                          | Called after the schema is written.
 `vite:extend`            | `viteBuildContext`         | Allows extending Vite default context.
-`vite:extendConfig`      | `viteInlineConfig, env`    | Allows extending Vite default config.
-`vite:configResolved`    | `viteInlineConfig, env`    | Allows reading the resolved Vite config.
+`vite:extendConfig`      | `viteInlineConfig, env`    | Allows extending Vite default config. **Deprecated in Nuxt 5+.** In Nuxt 5, this operates on a shared configuration rather than separate client/server configs.
+`vite:configResolved`    | `viteInlineConfig, env`    | Allows reading the resolved Vite config. **Deprecated in Nuxt 5+.** In Nuxt 5, this operates on a shared configuration rather than separate client/server configs.
 `vite:serverCreated`     | `viteServer, env`          | Called when the Vite server is created.
 `vite:compiled`          | -                          | Called after Vite server is compiled.
 `webpack:config`         | `webpackConfigs`           | Called before configuring the webpack compiler.

package/3.api/6.advanced/2.import-meta.md CHANGED Viewed

@@ -49,12 +49,12 @@ const resolver = createResolver(import.meta.url)
 export default defineNuxtModule({
   meta: { name: 'myModule' },
-  setup() {
+  setup () {
     addComponent({
       name: 'MyModuleComponent',
       // Resolves to '/modules/my-module/components/MyModuleComponent.vue'
-      filePath: resolver.resolve('./components/MyModuleComponent.vue')
+      filePath: resolver.resolve('./components/MyModuleComponent.vue'),
     })
-  }
+  },
 })
 ```

package/5.community/2.getting-help.md CHANGED Viewed

@@ -37,7 +37,7 @@ And finally, just ask the question! There's no need to [ask permission to ask a
 Something isn't working the way that the docs say that it should. You're not sure if it's a bug. You've searched through the [open issues](https://github.com/nuxt/nuxt/issues) and [discussions](https://github.com/nuxt/nuxt/discussions) but you can't find anything. (if there is a closed issue, please create a new one)
-We recommend taking a look at [how to report bugs](/docs/community/reporting-bugs). Nuxt is still in active development, and every issue helps make it better.
+We recommend taking a look at [how to report bugs](/docs/3.x/community/reporting-bugs). Nuxt is still in active development, and every issue helps make it better.
 ## "I need professional help"

package/5.community/3.reporting-bugs.md CHANGED Viewed

@@ -12,7 +12,7 @@ Here are a few key steps.
 ## Is It Really a Bug?
-Consider if you're looking to get help with something, or whether you think there's a bug with Nuxt itself. If it's the former, we'd love to help you - but the best way to do that is through [asking for help](/docs/community/getting-help) rather than reporting a bug.
+Consider if you're looking to get help with something, or whether you think there's a bug with Nuxt itself. If it's the former, we'd love to help you - but the best way to do that is through [asking for help](/docs/3.x/community/getting-help) rather than reporting a bug.
 ## Search the Issues

package/5.community/4.contribution.md CHANGED Viewed

@@ -11,7 +11,7 @@ There is a range of different ways you might be able to contribute to the Nuxt e
 The Nuxt ecosystem includes many different projects and organizations:
 * [nuxt/](https://github.com/nuxt) - core repositories for the Nuxt framework itself. [**nuxt/nuxt**](https://github.com/nuxt/nuxt) contains the Nuxt framework (both versions 2 and 3).
-* [nuxt-modules/](https://github.com/nuxt-modules) - community-contributed and maintained modules and libraries. There is a [process to migrate a module](/docs/guide/going-further/modules/#joining-nuxt-modules-and-nuxtjs) to `nuxt-modules`. While these modules have individual maintainers, they are not dependent on a single person.
+* [nuxt-modules/](https://github.com/nuxt-modules) - community-contributed and maintained modules and libraries. There is a [process to migrate a module](/docs/3.x/guide/going-further/modules/#joining-nuxt-modules-and-nuxtjs) to `nuxt-modules`. While these modules have individual maintainers, they are not dependent on a single person.
 * [unjs/](https://github.com/unjs) - many of these libraries are used throughout the Nuxt ecosystem. They are designed to be universal libraries that are framework- and environment-agnostic. We welcome contributions and usage by other frameworks and projects.
 ## How To Contribute
@@ -24,7 +24,7 @@ Check out the issues and discussions for the project you want to help. For examp
 Thank you for taking the time to create an issue! ❤️
-* **Reporting bugs**: Check out [our guide](/docs/community/reporting-bugs) for some things to do before opening an issue.
+* **Reporting bugs**: Check out [our guide](/docs/3.x/community/reporting-bugs) for some things to do before opening an issue.
 * **Feature requests**: Check that there is not an existing issue or discussion covering the scope of the feature you have in mind. If the feature is to another part of the Nuxt ecosystem (such as a module), please consider raising a feature request there first. If the feature you have in mind is general or the API is not entirely clear, consider opening a discussion in the **Ideas** section to discuss with the community first.
@@ -100,9 +100,9 @@ Our aim is ensuring quality and maintaining the joy of collaborating and communi
 ### Create a Module
-If you've built something with Nuxt that's cool, why not [extract it into a module](/docs/guide/going-further/modules), so it can be shared with others? We have [many excellent modules already](/modules), but there's always room for more.
+If you've built something with Nuxt that's cool, why not [extract it into a module](/docs/3.x/guide/going-further/modules), so it can be shared with others? We have [many excellent modules already](/modules), but there's always room for more.
-If you need help while building it, feel free to [check in with us](/docs/community/getting-help).
+If you need help while building it, feel free to [check in with us](/docs/3.x/community/getting-help).
 ### Make an RFC
@@ -126,7 +126,7 @@ The following conventions are _required_ within the `nuxt/` organization and rec
 #### Module Conventions
-Modules should follow the [Nuxt module template](https://github.com/nuxt/starter/tree/module). See [module guide](/docs/guide/going-further/modules) for more information.
+Modules should follow the [Nuxt module template](https://github.com/nuxt/starter/tree/module). See [module guide](/docs/3.x/guide/going-further/modules) for more information.
 #### Use Core `unjs/` Libraries
@@ -139,7 +139,7 @@ We recommend the following libraries which are used throughout the ecosystem:
 #### Use ESM Syntax and Default to `type: module`
-Most of the Nuxt ecosystem can consume ESM directly. In general we advocate that you avoid using CJS-specific code, such as `__dirname` and `require` statements. You can [read more about ESM](/docs/guide/concepts/esm).
+Most of the Nuxt ecosystem can consume ESM directly. In general we advocate that you avoid using CJS-specific code, such as `__dirname` and `require` statements. You can [read more about ESM](/docs/3.x/guide/concepts/esm).
 #### What's Corepack

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

@@ -4,7 +4,7 @@ navigation.icon: i-lucide-github
 description: Some specific points about contributions to the framework repository.
 ---
-Once you've read the [general contribution guide](/docs/community/contribution), here are some specific points to make about contributions to the [`nuxt/nuxt`](https://github.com/nuxt/nuxt) repository.
+Once you've read the [general contribution guide](/docs/3.x/community/contribution), here are some specific points to make about contributions to the [`nuxt/nuxt`](https://github.com/nuxt/nuxt) repository.
 ## Monorepo Guide
@@ -88,7 +88,7 @@ If there are still errors left, you must correct them manually.
 If you are adding a new feature or refactoring or changing the behavior of Nuxt in any other manner, you'll likely want to document the changes. Please include any changes to the docs in the same PR. You don't have to write documentation up on the first commit (but please do so as soon as your pull request is mature enough).
 ::important
-Make sure to make changes according to the [Documentation Style Guide](/docs/community/contribution#documentation-style-guide).
+Make sure to make changes according to the [Documentation Style Guide](/docs/3.x/community/contribution#documentation-style-guide).
 ::
 ### Final Checklist
@@ -100,7 +100,7 @@ When submitting your PR, there is a simple template that you have to fill out. P
 If you spot an area where we can improve documentation or error messages, please do open a PR - even if it's just to fix a typo!
 ::important
-Make sure to make changes according to the [Documentation Style Guide](/docs/community/contribution#documentation-style-guide).
+Make sure to make changes according to the [Documentation Style Guide](/docs/3.x/community/contribution#documentation-style-guide).
 ::
 ### Quick Edits

package/5.community/6.roadmap.md CHANGED Viewed

@@ -63,7 +63,7 @@ The current active version of [Nuxt](https://nuxt.com) is **v4** which is availa
 Nuxt 3 will continue to receive maintenance updates (both bug fixes and backports of features from Nuxt 4) until the end of January 2026.
-Each active version has its own nightly releases which are generated automatically. For more about enabling the Nuxt nightly release channel, see [the nightly release channel docs](/docs/guide/going-further/nightly-release-channel).
+Each active version has its own nightly releases which are generated automatically. For more about enabling the Nuxt nightly release channel, see [the nightly release channel docs](/docs/3.x/guide/going-further/nightly-release-channel).
 Release                    |                                                                                                                                                                               | Initial release       | End Of Life                  | Docs
 -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- | ---------------------------- | ---------------------------------------

package/6.bridge/1.overview.md CHANGED Viewed

@@ -4,11 +4,11 @@ description: Reduce the differences with Nuxt 3 and reduce the burden of migrati
 ---
 ::note
-If you're starting a fresh Nuxt 3 project, please skip this section and go to [Nuxt 3 Installation](/docs/getting-started/introduction).
+If you're starting a fresh Nuxt 3 project, please skip this section and go to [Nuxt 3 Installation](/docs/3.x/getting-started/introduction).
 ::
 ::warning
-Nuxt Bridge provides identical features to Nuxt 3 ([docs](/docs/guide/concepts/auto-imports)) but there are some limitations, notably that [`useAsyncData`](/docs/api/composables/use-async-data) and [`useFetch`](/docs/api/composables/use-fetch) composables are not available. Please read the rest of this page for details.
+Nuxt Bridge provides identical features to Nuxt 3 ([docs](/docs/3.x/guide/concepts/auto-imports)) but there are some limitations, notably that [`useAsyncData`](/docs/3.x/api/composables/use-async-data) and [`useFetch`](/docs/3.x/api/composables/use-fetch) composables are not available. Please read the rest of this page for details.
 ::
 Bridge is a forward-compatibility layer that allows you to experience many of the new Nuxt 3 features by simply installing and enabling a Nuxt module.
@@ -80,13 +80,13 @@ bun add -D @nuxt/bridge nuxi
 Please make sure to avoid any CommonJS syntax such as `module.exports`, `require` or `require.resolve` in your config file. It will soon be deprecated and unsupported.
-You can use static `import`, dynamic `import()` and `export default` instead. Using TypeScript by renaming to [`nuxt.config.ts`](/docs/guide/directory-structure/nuxt-config) is also possible and recommended.
+You can use static `import`, dynamic `import()` and `export default` instead. Using TypeScript by renaming to [`nuxt.config.ts`](/docs/3.x/guide/directory-structure/nuxt-config) is also possible and recommended.
 ```ts [nuxt.config.ts]
 import { defineNuxtConfig } from '@nuxt/bridge'
 export default defineNuxtConfig({
-  bridge: false
+  bridge: false,
 })
 ```
@@ -116,22 +116,22 @@ Try running `nuxt2` once here. You will see that the application works as before
 With Nuxt Bridge, the migration to Nuxt 3 can proceed in steps.
 The below `Upgrade Steps` does not need to be done all at once.
-- [TypeScript](/docs/bridge/typescript)
+- [TypeScript](/docs/3.x/bridge/typescript)
-- [Migrate Legacy Composition API](/docs/bridge/bridge-composition-api)
+- [Migrate Legacy Composition API](/docs/3.x/bridge/bridge-composition-api)
-- [Plugins and Middleware](/docs/bridge/plugins-and-middleware)
+- [Plugins and Middleware](/docs/3.x/bridge/plugins-and-middleware)
-- [Migrate New Composition API](/docs/bridge/nuxt3-compatible-api)
+- [Migrate New Composition API](/docs/3.x/bridge/nuxt3-compatible-api)
-- [Meta Tags](/docs/bridge/meta)
+- [Meta Tags](/docs/3.x/bridge/meta)
-- [Runtime Config](/docs/bridge/runtime-config)
+- [Runtime Config](/docs/3.x/bridge/runtime-config)
-- [Nitro](/docs/bridge/nitro)
+- [Nitro](/docs/3.x/bridge/nitro)
-- [Vite](/docs/bridge/vite)
+- [Vite](/docs/3.x/bridge/vite)
 ## Migrate from CommonJS to ESM
-Nuxt 3 natively supports TypeScript and ECMAScript Modules. Please check [Native ES Modules](/docs/guide/concepts/esm) for more info and upgrading.
+Nuxt 3 natively supports TypeScript and ECMAScript Modules. Please check [Native ES Modules](/docs/3.x/guide/concepts/esm) for more info and upgrading.

package/6.bridge/10.configuration.md CHANGED Viewed

@@ -11,6 +11,7 @@ You can check [bridge/src/module.ts](https://github.com/nuxt/bridge/blob/main/pa
 ```ts [nuxt.config.ts]
 import { defineNuxtConfig } from '@nuxt/bridge'
 export default defineNuxtConfig({
   bridge: {
@@ -63,7 +64,7 @@ export default defineNuxtConfig({
   vite: {
     // Config for Vite
-  }
+  },
 })
 ```

package/6.bridge/2.typescript.md CHANGED Viewed

@@ -16,8 +16,8 @@ import { defineNuxtConfig } from '@nuxt/bridge'
 export default defineNuxtConfig({
   bridge: {
     typescript: true,
-    nitro: false // If migration to Nitro is complete, set to true
-  }
+    nitro: false, // If migration to Nitro is complete, set to true
+  },
 })
 ```

package/6.bridge/3.bridge-composition-api.md CHANGED Viewed

@@ -35,9 +35,9 @@ Because some composables have been removed and don't yet have a replacement, thi
 You don't have to immediately update your imports yet - Nuxt Bridge will automatically provide a 'shim' for most imports you currently have, to give you time to migrate to the new, Nuxt 3-compatible composables, with the following exceptions:
-- `withContext` has been removed. See [below](/docs/bridge/nuxt3-compatible-api#usecontext-and-withcontext).
+- `withContext` has been removed. See [below](/docs/3.x/bridge/nuxt3-compatible-api#usecontext-and-withcontext).
 - `useStatic` has been removed. There is no current replacement. Feel free to raise a discussion if you have a use case for this.
-- `reqRef` and `reqSsrRef`, which were deprecated, have now been removed entirely. Follow the instructions below regarding [ssrRef](/docs/bridge/nuxt3-compatible-api#ssrref-and-shallowssrref) to replace this.
+- `reqRef` and `reqSsrRef`, which were deprecated, have now been removed entirely. Follow the instructions below regarding [ssrRef](/docs/3.x/bridge/nuxt3-compatible-api#ssrref-and-shallowssrref) to replace this.
 ### Set `bridge.capi`
@@ -47,8 +47,8 @@ import { defineNuxtConfig } from '@nuxt/bridge'
 export default defineNuxtConfig({
   bridge: {
     capi: true,
-    nitro: false // If migration to Nitro is complete, set to true
-  }
+    nitro: false, // If migration to Nitro is complete, set to true
+  },
 })
 ```
@@ -117,9 +117,9 @@ While this example is valid, Nuxt 3 introduces a new defineNuxtPlugin function t
 ### `useRouter` and `useRoute`
-Nuxt Bridge provides direct replacements for these composables via [`useRouter`](/docs/api/composables/use-router)  and `useRoute`.
+Nuxt Bridge provides direct replacements for these composables via [`useRouter`](/docs/3.x/api/composables/use-router)  and `useRoute`.
-The only key difference is that [`useRoute`](/docs/api/composables/use-route) no longer returns a computed property.
+The only key difference is that [`useRoute`](/docs/3.x/api/composables/use-route) no longer returns a computed property.
 ```diff
 - import { useRouter, useRoute } from '@nuxtjs/composition-api'

package/6.bridge/4.plugins-and-middleware.md CHANGED Viewed

@@ -7,17 +7,17 @@ description: 'Learn how to migrate from Nuxt 2 to Nuxt Bridge new plugins and mi
 You can now migrate to the Nuxt 3 plugins API, which is slightly different in format from Nuxt 2.
-Plugins now take only one argument (`nuxtApp`). You can find out more in [the docs](/docs/guide/directory-structure/plugins).
+Plugins now take only one argument (`nuxtApp`). You can find out more in [the docs](/docs/3.x/guide/directory-structure/plugins).
-```js [plugins/hello.ts]
-export default defineNuxtPlugin(nuxtApp => {
+```ts [plugins/hello.ts]
+export default defineNuxtPlugin((nuxtApp) => {
   nuxtApp.provide('injected', () => 'my injected function')
   // now available on `nuxtApp.$injected`
 })
 ```
 ::note
-If you want to use the new Nuxt composables (such as [`useNuxtApp`](/docs/api/composables/use-nuxt-app) or `useRuntimeConfig`) within your plugins, you will need to use the `defineNuxtPlugin` helper for those plugins.
+If you want to use the new Nuxt composables (such as [`useNuxtApp`](/docs/3.x/api/composables/use-nuxt-app) or `useRuntimeConfig`) within your plugins, you will need to use the `defineNuxtPlugin` helper for those plugins.
 ::
 ::warning
@@ -28,7 +28,7 @@ Although a compatibility interface is provided via `nuxtApp.vueApp` you should a
 You can now migrate to the Nuxt 3 middleware API, which is slightly different in format from Nuxt 2.
-Middleware now take only two argument (`to`, `from`). You can find out more in [the docs](/docs/guide/directory-structure/middleware).
+Middleware now take only two argument (`to`, `from`). You can find out more in [the docs](/docs/3.x/guide/directory-structure/middleware).
 ```ts twoslash
 export default defineNuxtRouteMiddleware((to) => {
@@ -44,7 +44,7 @@ Use of `defineNuxtRouteMiddleware` is not supported outside of the middleware di
 ## definePageMeta
-You can also use [`definePageMeta`](/docs/api/utils/define-page-meta) in Nuxt Bridge.
+You can also use [`definePageMeta`](/docs/3.x/api/utils/define-page-meta) in Nuxt Bridge.
 You can be enabled with the `macros.pageMeta` option in your configuration file
@@ -54,9 +54,9 @@ import { defineNuxtConfig } from '@nuxt/bridge'
 export default defineNuxtConfig({
   bridge: {
     macros: {
-      pageMeta: true
-    }
-  }
+      pageMeta: true,
+    },
+  },
 })
 ```

package/6.bridge/5.nuxt3-compatible-api.md CHANGED Viewed

@@ -9,7 +9,7 @@ By migrating from `@nuxtjs/composition-api` to the Nuxt 3 compatible API, there
 These two functions have been replaced with a new composable that works very similarly under the hood: `useState`.
-The key differences are that you must provide a _key_ for this state (which Nuxt generated automatically for `ssrRef` and `shallowSsrRef`), and that it can only be called within a Nuxt 3 plugin (which is defined by `defineNuxtPlugin`) or a component instance. (In other words, you cannot use [`useState`](/docs/api/composables/use-state) with a global/ambient context, because of the danger of shared state across requests.)
+The key differences are that you must provide a _key_ for this state (which Nuxt generated automatically for `ssrRef` and `shallowSsrRef`), and that it can only be called within a Nuxt 3 plugin (which is defined by `defineNuxtPlugin`) or a component instance. (In other words, you cannot use [`useState`](/docs/3.x/api/composables/use-state) with a global/ambient context, because of the danger of shared state across requests.)
 ```diff
 - import { ssrRef } from '@nuxtjs/composition-api'
@@ -24,7 +24,7 @@ The key differences are that you must provide a _key_ for this state (which Nuxt
 Because the state is keyed, you can access the same state from multiple locations, as long as you are using the same key.
-You can read more about how to use this composable in [the Nuxt 3 docs](/docs/api/composables/use-state).
+You can read more about how to use this composable in [the Nuxt 3 docs](/docs/3.x/api/composables/use-state).
 ## `ssrPromise`
@@ -32,7 +32,7 @@ This function has been removed, and you will need to find an alternative impleme
 ## `onGlobalSetup`
-This function has been removed, but its use cases can be met by using [`useNuxtApp`](/docs/api/composables/use-nuxt-app) or [`useState`](/docs/api/composables/use-state) within `defineNuxtPlugin`. You can also run any custom code within the `setup()` function of a layout.
+This function has been removed, but its use cases can be met by using [`useNuxtApp`](/docs/3.x/api/composables/use-nuxt-app) or [`useState`](/docs/3.x/api/composables/use-state) within `defineNuxtPlugin`. You can also run any custom code within the `setup()` function of a layout.
 ```diff
 - import { onGlobalSetup } from '@nuxtjs/composition-api'
@@ -73,8 +73,10 @@ You can access injected helpers using `useNuxtApp`.
 This helper function is not provided any more but you can replace it with the following code:
-```js
-const wrapProperty = (property, makeComputed = true) => () => {
+```ts
+import { computed, getCurrentInstance } from 'vue'
+const wrapProperty = (property: string, makeComputed = true) => () => {
   const vm = getCurrentInstance().proxy
   return makeComputed ? computed(() => vm[property]) : vm[property]
 }
@@ -82,14 +84,14 @@ const wrapProperty = (property, makeComputed = true) => () => {
 ## `useAsync` and `useFetch`
-These two composables can be replaced with `useLazyAsyncData` and `useLazyFetch`, which are documented [in the Nuxt 3 docs](/docs/getting-started/data-fetching). Just like the previous `@nuxtjs/composition-api` composables, these composables do not block route navigation on the client-side (hence the 'lazy' part of the name).
+These two composables can be replaced with `useLazyAsyncData` and `useLazyFetch`, which are documented [in the Nuxt 3 docs](/docs/3.x/getting-started/data-fetching). Just like the previous `@nuxtjs/composition-api` composables, these composables do not block route navigation on the client-side (hence the 'lazy' part of the name).
 ::important
 Note that the API is entirely different, despite similar sounding names. Importantly, you should not attempt to change the value of other variables outside the composable (as you may have been doing with the previous `useFetch`).
 ::
 ::warning
-The `useLazyFetch` must have been configured for [Nitro](/docs/bridge/nitro).
+The `useLazyFetch` must have been configured for [Nitro](/docs/3.x/bridge/nitro).
 ::
 Migrating to the new composables from `useAsync`:
@@ -136,7 +138,7 @@ In order to interact with `vue-meta`, you may use `useNuxt2Meta`, which will wor
 You can also pass in computed values or refs, and the meta values will be updated reactively:
-```ts
+```vue
 <script setup>
 const title = ref('my title')
 useNuxt2Meta({
@@ -150,7 +152,7 @@ title.value = 'new title'
 Be careful not to use both `useNuxt2Meta()` and the Options API `head()` within the same component, as behavior may be unpredictable.
 ::
-Nuxt Bridge also provides a Nuxt 3-compatible meta implementation that can be accessed with the [`useHead`](/docs/api/composables/use-head) composable.
+Nuxt Bridge also provides a Nuxt 3-compatible meta implementation that can be accessed with the [`useHead`](/docs/3.x/api/composables/use-head) composable.
 ```diff
 <script setup>
@@ -165,16 +167,17 @@ You will also need to enable it explicitly in your `nuxt.config`:
 ```js
 import { defineNuxtConfig } from '@nuxt/bridge'
 export default defineNuxtConfig({
   bridge: {
-    meta: true
-  }
+    meta: true,
+  },
 })
 ```
-This [`useHead`](/docs/api/composables/use-head) composable uses `@unhead/vue` under the hood (rather than `vue-meta`) to manipulate your `<head>`. Accordingly, it is recommended not to use both the native Nuxt 2 `head()` properties as well as [`useHead`](/docs/api/composables/use-head) , as they may conflict.
+This [`useHead`](/docs/3.x/api/composables/use-head) composable uses `@unhead/vue` under the hood (rather than `vue-meta`) to manipulate your `<head>`. Accordingly, it is recommended not to use both the native Nuxt 2 `head()` properties as well as [`useHead`](/docs/3.x/api/composables/use-head) , as they may conflict.
-For more information on how to use this composable, see [the Nuxt 3 docs](/docs/getting-started/seo-meta).
+For more information on how to use this composable, see [the Nuxt 3 docs](/docs/3.x/getting-started/seo-meta).
 ### Explicit Imports
@@ -182,7 +185,7 @@ Nuxt exposes every auto-import with the `#imports` alias that can be used to mak
 ```vue
 <script setup lang="ts">
-import { ref, computed } from '#imports'
+import { computed, ref } from '#imports'
 const count = ref(1)
 const double = computed(() => count.value * 2)
@@ -196,8 +199,8 @@ If you want to disable auto-importing composables and utilities, you can set `im
 ```ts [nuxt.config.ts]
 export default defineNuxtConfig({
   imports: {
-    autoImport: false
-  }
+    autoImport: false,
+  },
 })
 ```