@nuxt/docs 3.20.1 → 3.20.2

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 (202) hide show
  1. package/1.getting-started/01.introduction.md +1 -1
  2. package/1.getting-started/03.configuration.md +3 -3
  3. package/1.getting-started/04.views.md +5 -5
  4. package/1.getting-started/05.assets.md +7 -7
  5. package/1.getting-started/06.styling.md +3 -3
  6. package/1.getting-started/07.routing.md +5 -5
  7. package/1.getting-started/08.seo-meta.md +2 -2
  8. package/1.getting-started/09.transitions.md +6 -6
  9. package/1.getting-started/11.state-management.md +2 -2
  10. package/1.getting-started/12.error-handling.md +3 -3
  11. package/1.getting-started/14.layers.md +3 -3
  12. package/1.getting-started/16.deployment.md +1 -1
  13. package/1.getting-started/17.testing.md +1 -1
  14. package/{2.guide/1.directory-structure → 2.directory-structure}/0.nuxt.md +1 -1
  15. package/{2.guide/1.directory-structure → 2.directory-structure}/0.output.md +1 -1
  16. package/{2.guide/1.directory-structure → 2.directory-structure}/1.assets.md +2 -2
  17. package/{2.guide/1.directory-structure → 2.directory-structure}/1.components.md +1 -1
  18. package/{2.guide/1.directory-structure → 2.directory-structure}/1.composables.md +2 -2
  19. package/{2.guide/1.directory-structure → 2.directory-structure}/1.content.md +2 -2
  20. package/{2.guide/1.directory-structure → 2.directory-structure}/1.layouts.md +2 -2
  21. package/{2.guide/1.directory-structure → 2.directory-structure}/1.middleware.md +1 -1
  22. package/{2.guide/1.directory-structure → 2.directory-structure}/1.modules.md +2 -2
  23. package/{2.guide/1.directory-structure → 2.directory-structure}/1.node_modules.md +1 -1
  24. package/{2.guide/1.directory-structure → 2.directory-structure}/1.pages.md +6 -6
  25. package/{2.guide/1.directory-structure → 2.directory-structure}/1.plugins.md +2 -2
  26. package/{2.guide/1.directory-structure → 2.directory-structure}/1.server.md +1 -1
  27. package/{2.guide/1.directory-structure → 2.directory-structure}/1.shared.md +2 -2
  28. package/{2.guide/1.directory-structure → 2.directory-structure}/1.utils.md +3 -3
  29. package/{2.guide/1.directory-structure → 2.directory-structure}/2.env.md +1 -1
  30. package/{2.guide/1.directory-structure → 2.directory-structure}/2.nuxtignore.md +1 -1
  31. package/{2.guide/1.directory-structure → 2.directory-structure}/2.nuxtrc.md +1 -1
  32. package/{2.guide/1.directory-structure → 2.directory-structure}/3.app.md +2 -2
  33. package/{2.guide/1.directory-structure → 2.directory-structure}/3.error.md +1 -3
  34. package/{2.guide/1.directory-structure → 2.directory-structure}/3.nuxt-config.md +1 -1
  35. package/2.directory-structure/index.md +61 -0
  36. package/{2.guide → 3.guide}/0.index.md +6 -9
  37. package/{2.guide/2.concepts → 3.guide/1.concepts}/1.auto-imports.md +4 -4
  38. package/{2.guide/2.concepts → 3.guide/1.concepts}/10.nuxt-lifecycle.md +3 -3
  39. package/{2.guide/2.concepts → 3.guide/1.concepts}/2.vuejs-development.md +3 -3
  40. package/{2.guide/2.concepts → 3.guide/1.concepts}/3.rendering.md +1 -1
  41. package/{2.guide/2.concepts → 3.guide/1.concepts}/4.server-engine.md +2 -2
  42. package/{2.guide/2.concepts → 3.guide/1.concepts}/5.modules.md +1 -1
  43. package/{2.guide/2.concepts → 3.guide/1.concepts}/8.typescript.md +2 -2
  44. package/{2.guide/4.recipes → 3.guide/3.recipes}/1.custom-routing.md +1 -1
  45. package/{2.guide/4.recipes → 3.guide/3.recipes}/2.vite-plugin.md +1 -1
  46. package/{2.guide/4.recipes → 3.guide/3.recipes}/3.custom-usefetch.md +1 -1
  47. package/{2.guide/3.going-further → 3.guide/4.going-further}/1.experimental-features.md +2 -2
  48. package/{2.guide/3.going-further → 3.guide/4.going-further}/1.internals.md +2 -2
  49. package/{2.guide/3.going-further → 3.guide/4.going-further}/10.runtime-config.md +1 -1
  50. package/{2.guide/3.going-further → 3.guide/4.going-further}/2.hooks.md +2 -2
  51. package/{2.guide/3.going-further → 3.guide/4.going-further}/3.modules.md +2 -2
  52. package/{2.guide/3.going-further → 3.guide/4.going-further}/6.nuxt-app.md +1 -1
  53. package/{2.guide/3.going-further → 3.guide/4.going-further}/7.layers.md +11 -11
  54. package/{3.api → 4.api}/1.components/12.nuxt-route-announcer.md +1 -1
  55. package/{3.api → 4.api}/1.components/2.nuxt-page.md +1 -1
  56. package/{3.api → 4.api}/1.components/3.nuxt-layout.md +2 -2
  57. package/{3.api → 4.api}/1.components/5.nuxt-loading-indicator.md +1 -1
  58. package/{3.api → 4.api}/2.composables/use-nuxt-app.md +4 -4
  59. package/{3.api → 4.api}/2.composables/use-response-header.md +1 -1
  60. package/{3.api → 4.api}/2.composables/use-route.md +1 -1
  61. package/{3.api → 4.api}/2.composables/use-router.md +1 -1
  62. package/{3.api → 4.api}/3.utils/$fetch.md +1 -1
  63. package/{3.api → 4.api}/3.utils/abort-navigation.md +1 -1
  64. package/{3.api → 4.api}/3.utils/add-route-middleware.md +1 -1
  65. package/{3.api → 4.api}/3.utils/define-nuxt-plugin.md +1 -1
  66. package/{3.api → 4.api}/3.utils/define-nuxt-route-middleware.md +1 -1
  67. package/{3.api → 4.api}/3.utils/define-page-meta.md +5 -5
  68. package/{3.api → 4.api}/3.utils/update-app-config.md +1 -1
  69. package/{3.api → 4.api}/4.commands/module.md +2 -2
  70. package/{3.api → 4.api}/4.commands/prepare.md +1 -1
  71. package/{3.api → 4.api}/4.commands/preview.md +1 -1
  72. package/{3.api → 4.api}/4.commands/typecheck.md +1 -1
  73. package/{3.api → 4.api}/6.advanced/1.hooks.md +1 -1
  74. package/5.community/6.roadmap.md +6 -6
  75. package/5.community/7.changelog.md +10 -0
  76. package/6.bridge/1.overview.md +1 -1
  77. package/6.bridge/4.plugins-and-middleware.md +2 -2
  78. package/7.migration/2.configuration.md +1 -1
  79. package/7.migration/3.auto-imports.md +1 -1
  80. package/7.migration/6.pages-and-layouts.md +4 -4
  81. package/package.json +1 -1
  82. /package/{2.guide/1.directory-structure → 2.directory-structure}/.navigation.yml +0 -0
  83. /package/{2.guide/1.directory-structure → 2.directory-structure}/1.public.md +0 -0
  84. /package/{2.guide/1.directory-structure → 2.directory-structure}/2.gitignore.md +0 -0
  85. /package/{2.guide/1.directory-structure → 2.directory-structure}/3.app-config.md +0 -0
  86. /package/{2.guide/1.directory-structure → 2.directory-structure}/3.package.md +0 -0
  87. /package/{2.guide/1.directory-structure → 2.directory-structure}/3.tsconfig.md +0 -0
  88. /package/{2.guide → 3.guide}/.navigation.yml +0 -0
  89. /package/{2.guide/2.concepts → 3.guide/1.concepts}/.navigation.yml +0 -0
  90. /package/{2.guide/2.concepts → 3.guide/1.concepts}/7.esm.md +0 -0
  91. /package/{2.guide/2.concepts → 3.guide/1.concepts}/9.code-style.md +0 -0
  92. /package/{2.guide/5.best-practices → 3.guide/2.best-practices}/.navigation.yml +0 -0
  93. /package/{2.guide/5.best-practices → 3.guide/2.best-practices}/hydration.md +0 -0
  94. /package/{2.guide/5.best-practices → 3.guide/2.best-practices}/performance.md +0 -0
  95. /package/{2.guide/5.best-practices → 3.guide/2.best-practices}/plugins.md +0 -0
  96. /package/{2.guide/4.recipes → 3.guide/3.recipes}/.navigation.yml +0 -0
  97. /package/{2.guide/4.recipes → 3.guide/3.recipes}/4.sessions-and-authentication.md +0 -0
  98. /package/{2.guide/3.going-further → 3.guide/4.going-further}/.navigation.yml +0 -0
  99. /package/{2.guide/3.going-further → 3.guide/4.going-further}/1.events.md +0 -0
  100. /package/{2.guide/3.going-further → 3.guide/4.going-further}/1.features.md +0 -0
  101. /package/{2.guide/3.going-further → 3.guide/4.going-further}/11.nightly-release-channel.md +0 -0
  102. /package/{2.guide/3.going-further → 3.guide/4.going-further}/4.kit.md +0 -0
  103. /package/{2.guide/3.going-further → 3.guide/4.going-further}/9.debugging.md +0 -0
  104. /package/{2.guide/3.going-further → 3.guide/4.going-further}/index.md +0 -0
  105. /package/{3.api → 4.api}/.navigation.yml +0 -0
  106. /package/{3.api → 4.api}/1.components/.navigation.yml +0 -0
  107. /package/{3.api → 4.api}/1.components/1.client-only.md +0 -0
  108. /package/{3.api → 4.api}/1.components/1.dev-only.md +0 -0
  109. /package/{3.api → 4.api}/1.components/1.nuxt-client-fallback.md +0 -0
  110. /package/{3.api → 4.api}/1.components/10.nuxt-picture.md +0 -0
  111. /package/{3.api → 4.api}/1.components/11.teleports.md +0 -0
  112. /package/{3.api → 4.api}/1.components/13.nuxt-time.md +0 -0
  113. /package/{3.api → 4.api}/1.components/4.nuxt-link.md +0 -0
  114. /package/{3.api → 4.api}/1.components/6.nuxt-error-boundary.md +0 -0
  115. /package/{3.api → 4.api}/1.components/7.nuxt-welcome.md +0 -0
  116. /package/{3.api → 4.api}/1.components/8.nuxt-island.md +0 -0
  117. /package/{3.api → 4.api}/1.components/9.nuxt-img.md +0 -0
  118. /package/{3.api → 4.api}/2.composables/.navigation.yml +0 -0
  119. /package/{3.api → 4.api}/2.composables/on-prehydrate.md +0 -0
  120. /package/{3.api → 4.api}/2.composables/use-app-config.md +0 -0
  121. /package/{3.api → 4.api}/2.composables/use-async-data.md +0 -0
  122. /package/{3.api → 4.api}/2.composables/use-cookie.md +0 -0
  123. /package/{3.api → 4.api}/2.composables/use-error.md +0 -0
  124. /package/{3.api → 4.api}/2.composables/use-fetch.md +0 -0
  125. /package/{3.api → 4.api}/2.composables/use-head-safe.md +0 -0
  126. /package/{3.api → 4.api}/2.composables/use-head.md +0 -0
  127. /package/{3.api → 4.api}/2.composables/use-hydration.md +0 -0
  128. /package/{3.api → 4.api}/2.composables/use-lazy-async-data.md +0 -0
  129. /package/{3.api → 4.api}/2.composables/use-lazy-fetch.md +0 -0
  130. /package/{3.api → 4.api}/2.composables/use-loading-indicator.md +0 -0
  131. /package/{3.api → 4.api}/2.composables/use-nuxt-data.md +0 -0
  132. /package/{3.api → 4.api}/2.composables/use-preview-mode.md +0 -0
  133. /package/{3.api → 4.api}/2.composables/use-request-event.md +0 -0
  134. /package/{3.api → 4.api}/2.composables/use-request-fetch.md +0 -0
  135. /package/{3.api → 4.api}/2.composables/use-request-header.md +0 -0
  136. /package/{3.api → 4.api}/2.composables/use-request-headers.md +0 -0
  137. /package/{3.api → 4.api}/2.composables/use-request-url.md +0 -0
  138. /package/{3.api → 4.api}/2.composables/use-route-announcer.md +0 -0
  139. /package/{3.api → 4.api}/2.composables/use-runtime-config.md +0 -0
  140. /package/{3.api → 4.api}/2.composables/use-runtime-hook.md +0 -0
  141. /package/{3.api → 4.api}/2.composables/use-seo-meta.md +0 -0
  142. /package/{3.api → 4.api}/2.composables/use-server-seo-meta.md +0 -0
  143. /package/{3.api → 4.api}/2.composables/use-state.md +0 -0
  144. /package/{3.api → 4.api}/3.utils/.navigation.yml +0 -0
  145. /package/{3.api → 4.api}/3.utils/call-once.md +0 -0
  146. /package/{3.api → 4.api}/3.utils/clear-error.md +0 -0
  147. /package/{3.api → 4.api}/3.utils/clear-nuxt-data.md +0 -0
  148. /package/{3.api → 4.api}/3.utils/clear-nuxt-state.md +0 -0
  149. /package/{3.api → 4.api}/3.utils/create-error.md +0 -0
  150. /package/{3.api → 4.api}/3.utils/define-lazy-hydration-component.md +0 -0
  151. /package/{3.api → 4.api}/3.utils/define-nuxt-component.md +0 -0
  152. /package/{3.api → 4.api}/3.utils/define-route-rules.md +0 -0
  153. /package/{3.api → 4.api}/3.utils/navigate-to.md +0 -0
  154. /package/{3.api → 4.api}/3.utils/on-before-route-leave.md +0 -0
  155. /package/{3.api → 4.api}/3.utils/on-before-route-update.md +0 -0
  156. /package/{3.api → 4.api}/3.utils/on-nuxt-ready.md +0 -0
  157. /package/{3.api → 4.api}/3.utils/prefetch-components.md +0 -0
  158. /package/{3.api → 4.api}/3.utils/preload-components.md +0 -0
  159. /package/{3.api → 4.api}/3.utils/preload-route-components.md +0 -0
  160. /package/{3.api → 4.api}/3.utils/prerender-routes.md +0 -0
  161. /package/{3.api → 4.api}/3.utils/refresh-cookie.md +0 -0
  162. /package/{3.api → 4.api}/3.utils/refresh-nuxt-data.md +0 -0
  163. /package/{3.api → 4.api}/3.utils/reload-nuxt-app.md +0 -0
  164. /package/{3.api → 4.api}/3.utils/set-page-layout.md +0 -0
  165. /package/{3.api → 4.api}/3.utils/set-response-status.md +0 -0
  166. /package/{3.api → 4.api}/3.utils/show-error.md +0 -0
  167. /package/{3.api → 4.api}/4.commands/.navigation.yml +0 -0
  168. /package/{3.api → 4.api}/4.commands/add.md +0 -0
  169. /package/{3.api → 4.api}/4.commands/analyze.md +0 -0
  170. /package/{3.api → 4.api}/4.commands/build-module.md +0 -0
  171. /package/{3.api → 4.api}/4.commands/build.md +0 -0
  172. /package/{3.api → 4.api}/4.commands/cleanup.md +0 -0
  173. /package/{3.api → 4.api}/4.commands/dev.md +0 -0
  174. /package/{3.api → 4.api}/4.commands/devtools.md +0 -0
  175. /package/{3.api → 4.api}/4.commands/generate.md +0 -0
  176. /package/{3.api → 4.api}/4.commands/info.md +0 -0
  177. /package/{3.api → 4.api}/4.commands/init.md +0 -0
  178. /package/{3.api → 4.api}/4.commands/test.md +0 -0
  179. /package/{3.api → 4.api}/4.commands/upgrade.md +0 -0
  180. /package/{3.api → 4.api}/5.kit/.navigation.yml +0 -0
  181. /package/{3.api → 4.api}/5.kit/1.modules.md +0 -0
  182. /package/{3.api → 4.api}/5.kit/10.runtime-config.md +0 -0
  183. /package/{3.api → 4.api}/5.kit/10.templates.md +0 -0
  184. /package/{3.api → 4.api}/5.kit/11.nitro.md +0 -0
  185. /package/{3.api → 4.api}/5.kit/12.resolving.md +0 -0
  186. /package/{3.api → 4.api}/5.kit/13.logging.md +0 -0
  187. /package/{3.api → 4.api}/5.kit/14.builder.md +0 -0
  188. /package/{3.api → 4.api}/5.kit/15.examples.md +0 -0
  189. /package/{3.api → 4.api}/5.kit/16.layers.md +0 -0
  190. /package/{3.api → 4.api}/5.kit/2.programmatic.md +0 -0
  191. /package/{3.api → 4.api}/5.kit/3.compatibility.md +0 -0
  192. /package/{3.api → 4.api}/5.kit/4.autoimports.md +0 -0
  193. /package/{3.api → 4.api}/5.kit/5.components.md +0 -0
  194. /package/{3.api → 4.api}/5.kit/6.context.md +0 -0
  195. /package/{3.api → 4.api}/5.kit/7.pages.md +0 -0
  196. /package/{3.api → 4.api}/5.kit/8.layout.md +0 -0
  197. /package/{3.api → 4.api}/5.kit/9.head.md +0 -0
  198. /package/{3.api → 4.api}/5.kit/9.plugins.md +0 -0
  199. /package/{3.api → 4.api}/6.advanced/.navigation.yml +0 -0
  200. /package/{3.api → 4.api}/6.advanced/2.import-meta.md +0 -0
  201. /package/{3.api → 4.api}/6.nuxt-config.md +0 -0
  202. /package/{3.api → 4.api}/index.md +0 -0
@@ -9,7 +9,7 @@ links:
9
9
  ---
10
10
 
11
11
  ::note
12
- Route middleware are navigation guards stored in the [`middleware/`](/docs/3.x/guide/directory-structure/middleware) directory of your Nuxt application (unless [set otherwise](/docs/3.x/api/nuxt-config#middleware)).
12
+ Route middleware are navigation guards stored in the [`middleware/`](/docs/3.x/directory-structure/middleware) directory of your Nuxt application (unless [set otherwise](/docs/3.x/api/nuxt-config#middleware)).
13
13
  ::
14
14
 
15
15
  ## Type
@@ -42,7 +42,7 @@ interface ObjectPlugin<T> {
42
42
  ## Parameters
43
43
 
44
44
  **plugin**: A plugin can be defined in two ways:
45
- 1. **Function Plugin**: A function that receives the [`NuxtApp`](/docs/3.x/guide/going-further/internals#the-nuxtapp-interface) instance and can return a promise with an potential object with a [`provide`](/docs/3.x/guide/directory-structure/plugins#providing-helpers) property if you want to provide a helper on [`NuxtApp`](/docs/3.x/guide/going-further/internals#the-nuxtapp-interface) instance.
45
+ 1. **Function Plugin**: A function that receives the [`NuxtApp`](/docs/3.x/guide/going-further/internals#the-nuxtapp-interface) instance and can return a promise with an potential object with a [`provide`](/docs/3.x/directory-structure/plugins#providing-helpers) property if you want to provide a helper on [`NuxtApp`](/docs/3.x/guide/going-further/internals#the-nuxtapp-interface) instance.
46
46
  2. **Object Plugin**: An object that can include various properties to configure the plugin's behavior, such as `name`, `enforce`, `dependsOn`, `order`, `parallel`, `setup`, `hooks`, and `env`.
47
47
 
48
48
  | Property | Type | Required | Description |
@@ -8,7 +8,7 @@ links:
8
8
  size: xs
9
9
  ---
10
10
 
11
- Route middleware are stored in the [`middleware/`](/docs/3.x/guide/directory-structure/middleware) of your Nuxt application (unless [set otherwise](/docs/3.x/api/nuxt-config#middleware)).
11
+ Route middleware are stored in the [`middleware/`](/docs/3.x/directory-structure/middleware) of your Nuxt application (unless [set otherwise](/docs/3.x/api/nuxt-config#middleware)).
12
12
 
13
13
  ## Type
14
14
 
@@ -8,7 +8,7 @@ links:
8
8
  size: xs
9
9
  ---
10
10
 
11
- `definePageMeta` is a compiler macro that you can use to set metadata for your **page** components located in the [`pages/`](/docs/3.x/guide/directory-structure/pages) directory (unless [set otherwise](/docs/3.x/api/nuxt-config#pages)). This way you can set custom metadata for each static or dynamic route of your Nuxt application.
11
+ `definePageMeta` is a compiler macro that you can use to set metadata for your **page** components located in the [`pages/`](/docs/3.x/directory-structure/pages) directory (unless [set otherwise](/docs/3.x/api/nuxt-config#pages)). This way you can set custom metadata for each static or dynamic route of your Nuxt application.
12
12
 
13
13
  ```vue [pages/some-page.vue]
14
14
  <script setup lang="ts">
@@ -56,7 +56,7 @@ interface PageMeta {
56
56
 
57
57
  - **Type**: `string`
58
58
 
59
- You may define a name for this page's route. By default, name is generated based on path inside the [`pages/` directory](/docs/3.x/guide/directory-structure/pages).
59
+ You may define a name for this page's route. By default, name is generated based on path inside the [`pages/` directory](/docs/3.x/directory-structure/pages).
60
60
 
61
61
  **`path`**
62
62
 
@@ -104,7 +104,7 @@ interface PageMeta {
104
104
 
105
105
  - **Type**: `MiddlewareKey` | [`NavigationGuard`](https://router.vuejs.org/api/interfaces/NavigationGuard.html#navigationguard) | `Array<MiddlewareKey | NavigationGuard>`
106
106
 
107
- Define anonymous or named middleware directly within `definePageMeta`. Learn more about [route middleware](/docs/3.x/guide/directory-structure/middleware).
107
+ Define anonymous or named middleware directly within `definePageMeta`. Learn more about [route middleware](/docs/3.x/directory-structure/middleware).
108
108
 
109
109
  **`pageTransition`**
110
110
 
@@ -142,7 +142,7 @@ interface PageMeta {
142
142
 
143
143
  - **Type**: `any`
144
144
 
145
- Apart from the above properties, you can also set **custom** metadata. You may wish to do so in a type-safe way by [augmenting the type of the `meta` object](/docs/3.x/guide/directory-structure/pages/#typing-custom-metadata).
145
+ Apart from the above properties, you can also set **custom** metadata. You may wish to do so in a type-safe way by [augmenting the type of the `meta` object](/docs/3.x/directory-structure/pages/#typing-custom-metadata).
146
146
 
147
147
  ## Examples
148
148
 
@@ -219,7 +219,7 @@ For more examples see [Vue Router's Matching Syntax](https://router.vuejs.org/gu
219
219
 
220
220
  ### Defining Layout
221
221
 
222
- You can define the layout that matches the layout's file name located (by default) in the [`layouts/` directory](/docs/3.x/guide/directory-structure/layouts). You can also disable the layout by setting the `layout` to `false`:
222
+ You can define the layout that matches the layout's file name located (by default) in the [`layouts/` directory](/docs/3.x/directory-structure/layouts). You can also disable the layout by setting the `layout` to `false`:
223
223
 
224
224
  ```vue [pages/some-page.vue]
225
225
  <script setup lang="ts">
@@ -9,7 +9,7 @@ links:
9
9
  ---
10
10
 
11
11
  ::note
12
- Updates the [`app.config`](/docs/3.x/guide/directory-structure/app-config) using deep assignment. Existing (nested) properties will be preserved.
12
+ Updates the [`app.config`](/docs/3.x/directory-structure/app-config) using deep assignment. Existing (nested) properties will be preserved.
13
13
  ::
14
14
 
15
15
  ## Usage
@@ -39,8 +39,8 @@ The command lets you install [Nuxt modules](/modules) in your application with n
39
39
  When running the command, it will:
40
40
 
41
41
  - install the module as a dependency using your package manager
42
- - add it to your [package.json](/docs/3.x/guide/directory-structure/package) file
43
- - update your [`nuxt.config`](/docs/3.x/guide/directory-structure/nuxt-config) file
42
+ - add it to your [package.json](/docs/3.x/directory-structure/package) file
43
+ - update your [`nuxt.config`](/docs/3.x/directory-structure/nuxt-config) file
44
44
 
45
45
  **Example:**
46
46
 
@@ -14,7 +14,7 @@ npx nuxt prepare [ROOTDIR] [--dotenv] [--cwd=<directory>] [--logLevel=<silent|in
14
14
  ```
15
15
  <!--/prepare-cmd-->
16
16
 
17
- The `prepare` command creates a [`.nuxt`](/docs/3.x/guide/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/3.x/guide/directory-structure/package).
17
+ The `prepare` command creates a [`.nuxt`](/docs/3.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/3.x/directory-structure/package).
18
18
 
19
19
  ## Arguments
20
20
 
@@ -40,5 +40,5 @@ Option | Default | Description
40
40
  This command sets `process.env.NODE_ENV` to `production`. To override, define `NODE_ENV` in a `.env` file or as command-line argument.
41
41
 
42
42
  ::note
43
- For convenience, in preview mode, your [`.env`](/docs/3.x/guide/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.)
43
+ For convenience, in preview mode, your [`.env`](/docs/3.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.)
44
44
  ::
@@ -36,7 +36,7 @@ Option | Default | Description
36
36
  <!--/typecheck-opts-->
37
37
 
38
38
  ::note
39
- This command sets `process.env.NODE_ENV` to `production`. To override, define `NODE_ENV` in a [`.env`](/docs/3.x/guide/directory-structure/env) file or as a command-line argument.
39
+ 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.
40
40
  ::
41
41
 
42
42
  ::read-more{to="/docs/guide/concepts/typescript#type-checking"}
@@ -46,7 +46,7 @@ Hook | Arguments | Description
46
46
  `modules:done` | - | Called during Nuxt initialization, after installing user modules.
47
47
  `app:resolve` | `app` | Called after resolving the `app` instance.
48
48
  `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`).
49
- `app:templatesGenerated` | `app` | Called after templates are compiled into the [virtual file system](/docs/3.x/guide/directory-structure/nuxt#virtual-file-system) (vfs).
49
+ `app:templatesGenerated` | `app` | Called after templates are compiled into the [virtual file system](/docs/3.x/directory-structure/nuxt#virtual-file-system) (vfs).
50
50
  `build:before` | - | Called before Nuxt bundle builder.
51
51
  `build:done` | - | Called after Nuxt bundle builder is complete.
52
52
  `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.
@@ -38,12 +38,12 @@ Translations | - | [nuxt/translations#4](https://github.com/nuxt/tra
38
38
 
39
39
  In addition to the Nuxt framework, there are modules that are vital for the ecosystem. Their status will be updated below.
40
40
 
41
- Module | Status | Nuxt Support | Repository | Description
42
- ------------------------------------|---------------------|--------------|------------|-------------------
43
- [Scripts](https://scripts.nuxt.com) | Public Beta | 3.x, 4.x | [nuxt/scripts](https://github.com/nuxt/scripts) | Easy 3rd party script management.
44
- Auth Utils | Planned | 4.x, 5.x | `nuxt/auth-utils` to be announced | The temporary repository [atinux/nuxt-auth-utils](https://github.com/atinux/nuxt-auth-utils) is available while awaiting its official integration into Nuxt via RFC.
45
- A11y | Planned | 4.x, 5.x | `nuxt/a11y` to be announced | Accessibility hinting and utilities [nuxt/nuxt#23255](https://github.com/nuxt/nuxt/issues/23255)
46
- Hints | Planned | 4.x, 5.x | `nuxt/hints` to be announced | Guidance and suggestions for enhancing development practices.
41
+ Module | Status | Nuxt Support | Repository | Description
42
+ ---------------------------------------|---------------------|--------------|------------|-------------------
43
+ [Scripts](https://scripts.nuxt.com) | Public Beta | 3.x, 4.x | [nuxt/scripts](https://github.com/nuxt/scripts) | Easy 3rd party script management.
44
+ Auth Utils | Planned | 4.x, 5.x | `nuxt/auth-utils` to be announced | The temporary repository [atinux/nuxt-auth-utils](https://github.com/atinux/nuxt-auth-utils) is available while awaiting its official integration into Nuxt via RFC.
45
+ A11y | Planned | 4.x, 5.x | `nuxt/a11y` to be announced | Accessibility hinting and utilities [nuxt/nuxt#23255](https://github.com/nuxt/nuxt/issues/23255)
46
+ [Hints](https://github.com/nuxt/hints) | Public Alpha | 4.x, 5.x | [nuxt/hints](https://github.com/nuxt/hints) | Guidance and suggestions for enhancing development practices.
47
47
 
48
48
  ## Release Cycle
49
49
 
@@ -58,6 +58,16 @@ navigation.icon: i-lucide-bell-dot
58
58
  ::card
59
59
  ---
60
60
  icon: i-simple-icons-github
61
+ title: nuxt/hints
62
+ to: https://github.com/nuxt/hints/releases
63
+ target: _blank
64
+ ui.icon.base: text-black dark:text-white
65
+ ---
66
+ Nuxt Hints releases.
67
+ ::
68
+ ::card
69
+ ---
70
+ icon: i-simple-icons-github
61
71
  title: nuxt/image
62
72
  to: https://github.com/nuxt/image/releases
63
73
  target: _blank
@@ -80,7 +80,7 @@ bun add -D @nuxt/bridge nuxi
80
80
 
81
81
  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.
82
82
 
83
- 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.
83
+ You can use static `import`, dynamic `import()` and `export default` instead. Using TypeScript by renaming to [`nuxt.config.ts`](/docs/3.x/directory-structure/nuxt-config) is also possible and recommended.
84
84
 
85
85
  ```ts [nuxt.config.ts]
86
86
  import { defineNuxtConfig } from '@nuxt/bridge'
@@ -7,7 +7,7 @@ description: 'Learn how to migrate from Nuxt 2 to Nuxt Bridge new plugins and mi
7
7
 
8
8
  You can now migrate to the Nuxt 3 plugins API, which is slightly different in format from Nuxt 2.
9
9
 
10
- Plugins now take only one argument (`nuxtApp`). You can find out more in [the docs](/docs/3.x/guide/directory-structure/plugins).
10
+ Plugins now take only one argument (`nuxtApp`). You can find out more in [the docs](/docs/3.x/directory-structure/plugins).
11
11
 
12
12
  ```ts [plugins/hello.ts]
13
13
  export default defineNuxtPlugin((nuxtApp) => {
@@ -28,7 +28,7 @@ Although a compatibility interface is provided via `nuxtApp.vueApp` you should a
28
28
 
29
29
  You can now migrate to the Nuxt 3 middleware API, which is slightly different in format from Nuxt 2.
30
30
 
31
- Middleware now take only two argument (`to`, `from`). You can find out more in [the docs](/docs/3.x/guide/directory-structure/middleware).
31
+ Middleware now take only two argument (`to`, `from`). You can find out more in [the docs](/docs/3.x/directory-structure/middleware).
32
32
 
33
33
  ```ts twoslash
34
34
  export default defineNuxtRouteMiddleware((to) => {
@@ -213,7 +213,7 @@ export const useMainStore = defineStore('main', {
213
213
  })
214
214
  ```
215
215
 
216
- Create a [plugin](/docs/3.x/guide/directory-structure/plugins) file to globalize your store:
216
+ Create a [plugin](/docs/3.x/directory-structure/plugins) file to globalize your store:
217
217
 
218
218
  ```ts [plugins/pinia.ts]
219
219
  import { useMainStore } from '~/store'
@@ -11,7 +11,7 @@ In the rest of the migration documentation, you will notice that key Nuxt and Vu
11
11
 
12
12
  ## Migration
13
13
 
14
- 1. If you have been using `@nuxt/components` in Nuxt 2, you can remove `components: true` in your `nuxt.config`. If you had a more complex setup, then note that the component options have changed somewhat. See the [components documentation](/docs/3.x/guide/directory-structure/components) for more information.
14
+ 1. If you have been using `@nuxt/components` in Nuxt 2, you can remove `components: true` in your `nuxt.config`. If you had a more complex setup, then note that the component options have changed somewhat. See the [components documentation](/docs/3.x/directory-structure/components) for more information.
15
15
 
16
16
  ::tip
17
17
  You can look at `.nuxt/types/components.d.ts` and `.nuxt/types/imports.d.ts` to see how Nuxt has resolved your components and composable auto-imports.
@@ -19,13 +19,13 @@ This file is a great place to put any custom code that needs to be run once when
19
19
 
20
20
  ### Migration
21
21
 
22
- Consider creating an `app.vue` file and including any logic that needs to run once at the top-level of your app. You can check out [an example here](/docs/3.x/guide/directory-structure/app).
22
+ Consider creating an `app.vue` file and including any logic that needs to run once at the top-level of your app. You can check out [an example here](/docs/3.x/directory-structure/app).
23
23
 
24
24
  ## Layouts
25
25
 
26
26
  If you are using layouts in your app for multiple pages, there is only a slight change required.
27
27
 
28
- In Nuxt 2, the `<Nuxt>` component is used within a layout to render the current page. In Nuxt 3, layouts use slots instead, so you will have to replace that component with a `<slot />`. This also allows advanced use cases with named and scoped slots. [Read more about layouts](/docs/3.x/guide/directory-structure/layouts).
28
+ In Nuxt 2, the `<Nuxt>` component is used within a layout to render the current page. In Nuxt 3, layouts use slots instead, so you will have to replace that component with a `<slot />`. This also allows advanced use cases with named and scoped slots. [Read more about layouts](/docs/3.x/directory-structure/layouts).
29
29
 
30
30
  You will also need to change how you define the layout used by a page using the `definePageMeta` compiler macro. Layouts will be kebab-cased. So `layouts/customLayout.vue` becomes `custom-layout` when referenced in your page.
31
31
 
@@ -54,7 +54,7 @@ You will also need to change how you define the layout used by a page using the
54
54
  - }
55
55
  </script>
56
56
  ```
57
- 3. Move `~/layouts/_error.vue` to `~/error.vue`. See [the error handling docs](/docs/3.x/getting-started/error-handling). If you want to ensure that this page uses a layout, you can use [`<NuxtLayout>`](/docs/3.x/guide/directory-structure/layouts) directly within `error.vue`:
57
+ 3. Move `~/layouts/_error.vue` to `~/error.vue`. See [the error handling docs](/docs/3.x/getting-started/error-handling). If you want to ensure that this page uses a layout, you can use [`<NuxtLayout>`](/docs/3.x/directory-structure/layouts) directly within `error.vue`:
58
58
  ```vue [error.vue]
59
59
  <template>
60
60
  <div>
@@ -67,7 +67,7 @@ You will also need to change how you define the layout used by a page using the
67
67
 
68
68
  ## Pages
69
69
 
70
- Nuxt 3 ships with an optional `vue-router` integration triggered by the existence of a [`pages/`](/docs/3.x/guide/directory-structure/pages) directory in your source directory. If you only have a single page, you may consider instead moving it to `app.vue` for a lighter build.
70
+ Nuxt 3 ships with an optional `vue-router` integration triggered by the existence of a [`pages/`](/docs/3.x/directory-structure/pages) directory in your source directory. If you only have a single page, you may consider instead moving it to `app.vue` for a lighter build.
71
71
 
72
72
  ### Dynamic Routes
73
73
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@nuxt/docs",
3
- "version": "3.20.1",
3
+ "version": "3.20.2",
4
4
  "repository": {
5
5
  "type": "git",
6
6
  "url": "git+https://github.com/nuxt/nuxt.git",
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes