@nuxt/docs 4.2.1 → 4.2.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 (230) hide show
  1. package/1.getting-started/01.introduction.md +1 -1
  2. package/1.getting-started/03.configuration.md +27 -27
  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 +5 -5
  6. package/1.getting-started/07.routing.md +7 -7
  7. package/1.getting-started/08.seo-meta.md +3 -3
  8. package/1.getting-started/09.transitions.md +6 -6
  9. package/1.getting-started/10.data-fetching.md +2 -2
  10. package/1.getting-started/11.state-management.md +2 -2
  11. package/1.getting-started/12.error-handling.md +3 -3
  12. package/1.getting-started/13.server.md +2 -2
  13. package/1.getting-started/14.layers.md +3 -3
  14. package/1.getting-started/16.deployment.md +1 -1
  15. package/1.getting-started/17.testing.md +32 -1
  16. package/1.getting-started/18.upgrade.md +23 -23
  17. package/{2.guide/1.directory-structure → 2.directory-structure}/0.nuxt.md +1 -1
  18. package/{2.guide/1.directory-structure → 2.directory-structure}/0.output.md +1 -1
  19. package/{2.guide/1.directory-structure → 2.directory-structure}/1.app/1.assets.md +2 -2
  20. package/{2.guide/1.directory-structure → 2.directory-structure}/1.app/1.components.md +2 -2
  21. package/{2.guide/1.directory-structure → 2.directory-structure}/1.app/1.composables.md +2 -2
  22. package/{2.guide/1.directory-structure → 2.directory-structure}/1.app/1.layouts.md +3 -3
  23. package/{2.guide/1.directory-structure → 2.directory-structure}/1.app/1.middleware.md +1 -1
  24. package/{2.guide/1.directory-structure → 2.directory-structure}/1.app/1.pages.md +7 -7
  25. package/{2.guide/1.directory-structure → 2.directory-structure}/1.app/1.plugins.md +2 -2
  26. package/{2.guide/1.directory-structure → 2.directory-structure}/1.app/1.utils.md +3 -3
  27. package/{2.guide/1.directory-structure → 2.directory-structure}/1.app/3.app.md +4 -4
  28. package/{2.guide/1.directory-structure → 2.directory-structure}/1.app/3.error.md +1 -3
  29. package/{2.guide/1.directory-structure → 2.directory-structure}/1.content.md +2 -2
  30. package/{2.guide/1.directory-structure → 2.directory-structure}/1.modules.md +1 -1
  31. package/{2.guide/1.directory-structure → 2.directory-structure}/1.node_modules.md +1 -1
  32. package/{2.guide/1.directory-structure → 2.directory-structure}/1.server.md +3 -3
  33. package/{2.guide/1.directory-structure → 2.directory-structure}/1.shared.md +3 -3
  34. package/{2.guide/1.directory-structure → 2.directory-structure}/2.env.md +2 -2
  35. package/{2.guide/1.directory-structure → 2.directory-structure}/2.nuxtignore.md +1 -1
  36. package/{2.guide/1.directory-structure → 2.directory-structure}/2.nuxtrc.md +1 -1
  37. package/{2.guide/1.directory-structure → 2.directory-structure}/3.nuxt-config.md +1 -1
  38. package/{2.guide/1.directory-structure → 2.directory-structure}/3.package.md +1 -1
  39. package/2.directory-structure/index.md +61 -0
  40. package/{2.guide → 3.guide}/0.index.md +4 -7
  41. package/{2.guide/2.concepts/3.rendering.md → 3.guide/1.concepts/1.rendering.md} +1 -27
  42. package/{2.guide/2.concepts/2.vuejs-development.md → 3.guide/1.concepts/10.vuejs-development.md} +4 -3
  43. package/{2.guide/2.concepts/10.nuxt-lifecycle.md → 3.guide/1.concepts/2.nuxt-lifecycle.md} +32 -25
  44. package/{2.guide/2.concepts/1.auto-imports.md → 3.guide/1.concepts/3.auto-imports.md} +5 -5
  45. package/{2.guide/2.concepts → 3.guide/1.concepts}/4.server-engine.md +3 -3
  46. package/{2.guide/2.concepts → 3.guide/1.concepts}/5.modules.md +1 -1
  47. package/{2.guide/2.concepts → 3.guide/1.concepts}/7.esm.md +1 -0
  48. package/{2.guide/2.concepts → 3.guide/1.concepts}/8.typescript.md +4 -4
  49. package/{2.guide/5.best-practices → 3.guide/2.best-practices}/performance.md +2 -2
  50. package/3.guide/3.ai/.navigation.yml +3 -0
  51. package/3.guide/3.ai/1.mcp.md +255 -0
  52. package/3.guide/3.ai/2.llms-txt.md +65 -0
  53. package/{2.guide → 3.guide}/4.recipes/1.custom-routing.md +1 -1
  54. package/{2.guide → 3.guide}/4.recipes/2.vite-plugin.md +1 -1
  55. package/{2.guide → 3.guide}/4.recipes/3.custom-usefetch.md +1 -1
  56. package/{2.guide → 3.guide}/4.recipes/4.sessions-and-authentication.md +1 -1
  57. package/{2.guide/3.going-further → 3.guide/5.going-further}/1.events.md +2 -3
  58. package/{2.guide/3.going-further → 3.guide/5.going-further}/1.experimental-features.md +4 -4
  59. package/{2.guide/3.going-further → 3.guide/5.going-further}/1.internals.md +3 -2
  60. package/{2.guide/3.going-further → 3.guide/5.going-further}/10.runtime-config.md +2 -2
  61. package/{2.guide/3.going-further → 3.guide/5.going-further}/2.hooks.md +2 -2
  62. package/{2.guide/3.going-further → 3.guide/5.going-further}/3.modules.md +2 -2
  63. package/{2.guide/3.going-further → 3.guide/5.going-further}/6.nuxt-app.md +3 -3
  64. package/{2.guide/3.going-further → 3.guide/5.going-further}/7.layers.md +12 -12
  65. package/{3.api → 4.api}/1.components/12.nuxt-route-announcer.md +1 -3
  66. package/{3.api → 4.api}/1.components/13.nuxt-time.md +0 -2
  67. package/{3.api → 4.api}/1.components/2.nuxt-page.md +2 -2
  68. package/{3.api → 4.api}/1.components/3.nuxt-layout.md +5 -5
  69. package/{3.api → 4.api}/1.components/5.nuxt-loading-indicator.md +1 -1
  70. package/{3.api → 4.api}/1.components/7.nuxt-welcome.md +2 -2
  71. package/{3.api → 4.api}/2.composables/use-app-config.md +1 -1
  72. package/4.api/2.composables/use-cookie.md +183 -0
  73. package/{3.api → 4.api}/2.composables/use-fetch.md +31 -31
  74. package/{3.api → 4.api}/2.composables/use-lazy-fetch.md +8 -8
  75. package/{3.api → 4.api}/2.composables/use-nuxt-app.md +4 -4
  76. package/{3.api → 4.api}/2.composables/use-response-header.md +1 -1
  77. package/{3.api → 4.api}/2.composables/use-route-announcer.md +0 -2
  78. package/{3.api → 4.api}/2.composables/use-route.md +1 -1
  79. package/{3.api → 4.api}/2.composables/use-router.md +2 -2
  80. package/{3.api → 4.api}/2.composables/use-runtime-config.md +1 -1
  81. package/{3.api → 4.api}/3.utils/$fetch.md +1 -1
  82. package/{3.api → 4.api}/3.utils/abort-navigation.md +1 -1
  83. package/{3.api → 4.api}/3.utils/add-route-middleware.md +1 -1
  84. package/{3.api → 4.api}/3.utils/call-once.md +0 -2
  85. package/{3.api → 4.api}/3.utils/define-nuxt-plugin.md +12 -12
  86. package/{3.api → 4.api}/3.utils/define-nuxt-route-middleware.md +1 -1
  87. package/{3.api → 4.api}/3.utils/define-page-meta.md +6 -6
  88. package/{3.api → 4.api}/3.utils/navigate-to.md +10 -10
  89. package/{3.api → 4.api}/3.utils/refresh-cookie.md +0 -2
  90. package/{3.api → 4.api}/3.utils/update-app-config.md +2 -2
  91. package/{3.api → 4.api}/4.commands/add.md +10 -10
  92. package/4.api/4.commands/analyze.md +42 -0
  93. package/4.api/4.commands/build-module.md +42 -0
  94. package/4.api/4.commands/build.md +47 -0
  95. package/{3.api → 4.api}/4.commands/cleanup.md +6 -6
  96. package/4.api/4.commands/dev.md +60 -0
  97. package/{3.api → 4.api}/4.commands/devtools.md +7 -7
  98. package/4.api/4.commands/generate.md +42 -0
  99. package/4.api/4.commands/info.md +33 -0
  100. package/4.api/4.commands/init.md +50 -0
  101. package/4.api/4.commands/module.md +84 -0
  102. package/4.api/4.commands/prepare.md +41 -0
  103. package/4.api/4.commands/preview.md +44 -0
  104. package/4.api/4.commands/test.md +40 -0
  105. package/4.api/4.commands/typecheck.md +44 -0
  106. package/4.api/4.commands/upgrade.md +37 -0
  107. package/{3.api → 4.api}/5.kit/1.modules.md +16 -16
  108. package/{3.api → 4.api}/5.kit/10.templates.md +23 -23
  109. package/{3.api → 4.api}/5.kit/11.nitro.md +35 -35
  110. package/{3.api → 4.api}/5.kit/14.builder.md +15 -15
  111. package/{3.api → 4.api}/5.kit/16.layers.md +12 -12
  112. package/{3.api → 4.api}/5.kit/2.programmatic.md +2 -2
  113. package/{3.api → 4.api}/5.kit/4.autoimports.md +18 -18
  114. package/4.api/5.kit/5.components.md +146 -0
  115. package/4.api/6.advanced/1.hooks.md +105 -0
  116. package/{3.api → 4.api}/6.nuxt-config.md +5 -4
  117. package/5.community/6.roadmap.md +25 -25
  118. package/5.community/7.changelog.md +10 -0
  119. package/6.bridge/1.overview.md +1 -1
  120. package/6.bridge/2.typescript.md +1 -1
  121. package/6.bridge/3.bridge-composition-api.md +1 -1
  122. package/6.bridge/4.plugins-and-middleware.md +2 -2
  123. package/7.migration/11.server.md +1 -1
  124. package/7.migration/2.configuration.md +2 -2
  125. package/7.migration/20.module-authors.md +1 -1
  126. package/7.migration/3.auto-imports.md +1 -1
  127. package/7.migration/5.plugins-and-middleware.md +2 -2
  128. package/7.migration/6.pages-and-layouts.md +6 -6
  129. package/package.json +1 -1
  130. package/3.api/2.composables/use-cookie.md +0 -183
  131. package/3.api/4.commands/analyze.md +0 -42
  132. package/3.api/4.commands/build-module.md +0 -42
  133. package/3.api/4.commands/build.md +0 -47
  134. package/3.api/4.commands/dev.md +0 -60
  135. package/3.api/4.commands/generate.md +0 -42
  136. package/3.api/4.commands/info.md +0 -33
  137. package/3.api/4.commands/init.md +0 -50
  138. package/3.api/4.commands/module.md +0 -84
  139. package/3.api/4.commands/prepare.md +0 -41
  140. package/3.api/4.commands/preview.md +0 -44
  141. package/3.api/4.commands/test.md +0 -40
  142. package/3.api/4.commands/typecheck.md +0 -44
  143. package/3.api/4.commands/upgrade.md +0 -37
  144. package/3.api/5.kit/5.components.md +0 -146
  145. package/3.api/6.advanced/1.hooks.md +0 -105
  146. /package/{2.guide/1.directory-structure → 2.directory-structure}/.navigation.yml +0 -0
  147. /package/{2.guide/1.directory-structure → 2.directory-structure}/1.app/.navigation.yml +0 -0
  148. /package/{2.guide/1.directory-structure → 2.directory-structure}/1.app/3.app-config.md +0 -0
  149. /package/{2.guide/1.directory-structure → 2.directory-structure}/1.public.md +0 -0
  150. /package/{2.guide/1.directory-structure → 2.directory-structure}/2.gitignore.md +0 -0
  151. /package/{2.guide/1.directory-structure → 2.directory-structure}/3.tsconfig.md +0 -0
  152. /package/{2.guide → 3.guide}/.navigation.yml +0 -0
  153. /package/{2.guide/2.concepts → 3.guide/1.concepts}/.navigation.yml +0 -0
  154. /package/{2.guide/2.concepts → 3.guide/1.concepts}/9.code-style.md +0 -0
  155. /package/{2.guide/5.best-practices → 3.guide/2.best-practices}/.navigation.yml +0 -0
  156. /package/{2.guide/5.best-practices → 3.guide/2.best-practices}/hydration.md +0 -0
  157. /package/{2.guide/5.best-practices → 3.guide/2.best-practices}/plugins.md +0 -0
  158. /package/{2.guide → 3.guide}/4.recipes/.navigation.yml +0 -0
  159. /package/{2.guide/3.going-further → 3.guide/5.going-further}/.navigation.yml +0 -0
  160. /package/{2.guide/3.going-further → 3.guide/5.going-further}/1.features.md +0 -0
  161. /package/{2.guide/3.going-further → 3.guide/5.going-further}/11.nightly-release-channel.md +0 -0
  162. /package/{2.guide/3.going-further → 3.guide/5.going-further}/4.kit.md +0 -0
  163. /package/{2.guide/3.going-further → 3.guide/5.going-further}/9.debugging.md +0 -0
  164. /package/{2.guide/3.going-further → 3.guide/5.going-further}/index.md +0 -0
  165. /package/{3.api → 4.api}/.navigation.yml +0 -0
  166. /package/{3.api → 4.api}/1.components/.navigation.yml +0 -0
  167. /package/{3.api → 4.api}/1.components/1.client-only.md +0 -0
  168. /package/{3.api → 4.api}/1.components/1.dev-only.md +0 -0
  169. /package/{3.api → 4.api}/1.components/1.nuxt-client-fallback.md +0 -0
  170. /package/{3.api → 4.api}/1.components/10.nuxt-picture.md +0 -0
  171. /package/{3.api → 4.api}/1.components/11.teleports.md +0 -0
  172. /package/{3.api → 4.api}/1.components/4.nuxt-link.md +0 -0
  173. /package/{3.api → 4.api}/1.components/6.nuxt-error-boundary.md +0 -0
  174. /package/{3.api → 4.api}/1.components/8.nuxt-island.md +0 -0
  175. /package/{3.api → 4.api}/1.components/9.nuxt-img.md +0 -0
  176. /package/{3.api → 4.api}/2.composables/.navigation.yml +0 -0
  177. /package/{3.api → 4.api}/2.composables/on-prehydrate.md +0 -0
  178. /package/{3.api → 4.api}/2.composables/use-async-data.md +0 -0
  179. /package/{3.api → 4.api}/2.composables/use-error.md +0 -0
  180. /package/{3.api → 4.api}/2.composables/use-head-safe.md +0 -0
  181. /package/{3.api → 4.api}/2.composables/use-head.md +0 -0
  182. /package/{3.api → 4.api}/2.composables/use-hydration.md +0 -0
  183. /package/{3.api → 4.api}/2.composables/use-lazy-async-data.md +0 -0
  184. /package/{3.api → 4.api}/2.composables/use-loading-indicator.md +0 -0
  185. /package/{3.api → 4.api}/2.composables/use-nuxt-data.md +0 -0
  186. /package/{3.api → 4.api}/2.composables/use-preview-mode.md +0 -0
  187. /package/{3.api → 4.api}/2.composables/use-request-event.md +0 -0
  188. /package/{3.api → 4.api}/2.composables/use-request-fetch.md +0 -0
  189. /package/{3.api → 4.api}/2.composables/use-request-header.md +0 -0
  190. /package/{3.api → 4.api}/2.composables/use-request-headers.md +0 -0
  191. /package/{3.api → 4.api}/2.composables/use-request-url.md +0 -0
  192. /package/{3.api → 4.api}/2.composables/use-runtime-hook.md +0 -0
  193. /package/{3.api → 4.api}/2.composables/use-seo-meta.md +0 -0
  194. /package/{3.api → 4.api}/2.composables/use-server-seo-meta.md +0 -0
  195. /package/{3.api → 4.api}/2.composables/use-state.md +0 -0
  196. /package/{3.api → 4.api}/3.utils/.navigation.yml +0 -0
  197. /package/{3.api → 4.api}/3.utils/clear-error.md +0 -0
  198. /package/{3.api → 4.api}/3.utils/clear-nuxt-data.md +0 -0
  199. /package/{3.api → 4.api}/3.utils/clear-nuxt-state.md +0 -0
  200. /package/{3.api → 4.api}/3.utils/create-error.md +0 -0
  201. /package/{3.api → 4.api}/3.utils/define-lazy-hydration-component.md +0 -0
  202. /package/{3.api → 4.api}/3.utils/define-nuxt-component.md +0 -0
  203. /package/{3.api → 4.api}/3.utils/define-route-rules.md +0 -0
  204. /package/{3.api → 4.api}/3.utils/on-before-route-leave.md +0 -0
  205. /package/{3.api → 4.api}/3.utils/on-before-route-update.md +0 -0
  206. /package/{3.api → 4.api}/3.utils/on-nuxt-ready.md +0 -0
  207. /package/{3.api → 4.api}/3.utils/prefetch-components.md +0 -0
  208. /package/{3.api → 4.api}/3.utils/preload-components.md +0 -0
  209. /package/{3.api → 4.api}/3.utils/preload-route-components.md +0 -0
  210. /package/{3.api → 4.api}/3.utils/prerender-routes.md +0 -0
  211. /package/{3.api → 4.api}/3.utils/refresh-nuxt-data.md +0 -0
  212. /package/{3.api → 4.api}/3.utils/reload-nuxt-app.md +0 -0
  213. /package/{3.api → 4.api}/3.utils/set-page-layout.md +0 -0
  214. /package/{3.api → 4.api}/3.utils/set-response-status.md +0 -0
  215. /package/{3.api → 4.api}/3.utils/show-error.md +0 -0
  216. /package/{3.api → 4.api}/4.commands/.navigation.yml +0 -0
  217. /package/{3.api → 4.api}/5.kit/.navigation.yml +0 -0
  218. /package/{3.api → 4.api}/5.kit/10.runtime-config.md +0 -0
  219. /package/{3.api → 4.api}/5.kit/12.resolving.md +0 -0
  220. /package/{3.api → 4.api}/5.kit/13.logging.md +0 -0
  221. /package/{3.api → 4.api}/5.kit/15.examples.md +0 -0
  222. /package/{3.api → 4.api}/5.kit/3.compatibility.md +0 -0
  223. /package/{3.api → 4.api}/5.kit/6.context.md +0 -0
  224. /package/{3.api → 4.api}/5.kit/7.pages.md +0 -0
  225. /package/{3.api → 4.api}/5.kit/8.layout.md +0 -0
  226. /package/{3.api → 4.api}/5.kit/9.head.md +0 -0
  227. /package/{3.api → 4.api}/5.kit/9.plugins.md +0 -0
  228. /package/{3.api → 4.api}/6.advanced/.navigation.yml +0 -0
  229. /package/{3.api → 4.api}/6.advanced/2.import-meta.md +0 -0
  230. /package/{3.api → 4.api}/index.md +0 -0
@@ -69,14 +69,14 @@ export function useLazyFetch<DataT, ErrorT> (
69
69
 
70
70
  Returns the same `AsyncData` object as [`useFetch`](/docs/4.x/api/composables/use-fetch):
71
71
 
72
- | Name | Type | Description |
73
- | --- | --- |--- |
74
- | `data` | `Ref<DataT \| undefined>` | The result of the asynchronous fetch. |
75
- | `refresh` | `(opts?: AsyncDataExecuteOptions) => Promise<void>` | Function to manually refresh the data. |
76
- | `execute` | `(opts?: AsyncDataExecuteOptions) => Promise<void>` | Alias for `refresh`. |
77
- | `error` | `Ref<ErrorT \| undefined>` | Error object if the data fetching failed. |
78
- | `status` | `Ref<'idle' \| 'pending' \| 'success' \| 'error'>` | Status of the data request. |
79
- | `clear` | `() => void` | Resets `data` to `undefined`, `error` to `undefined`, sets `status` to `idle`, and cancels any pending requests. |
72
+ | Name | Type | Description |
73
+ |-----------|-----------------------------------------------------|------------------------------------------------------------------------------------------------------------------|
74
+ | `data` | `Ref<DataT \| undefined>` | The result of the asynchronous fetch. |
75
+ | `refresh` | `(opts?: AsyncDataExecuteOptions) => Promise<void>` | Function to manually refresh the data. |
76
+ | `execute` | `(opts?: AsyncDataExecuteOptions) => Promise<void>` | Alias for `refresh`. |
77
+ | `error` | `Ref<ErrorT \| undefined>` | Error object if the data fetching failed. |
78
+ | `status` | `Ref<'idle' \| 'pending' \| 'success' \| 'error'>` | Status of the data request. |
79
+ | `clear` | `() => void` | Resets `data` to `undefined`, `error` to `undefined`, sets `status` to `idle`, and cancels any pending requests. |
80
80
 
81
81
  :read-more{to="/docs/4.x/api/composables/use-fetch#return-values"}
82
82
 
@@ -30,7 +30,7 @@ By default, the shared runtime context of Nuxt is namespaced under the [`buildId
30
30
 
31
31
  ### `provide (name, value)`
32
32
 
33
- `nuxtApp` is a runtime context that you can extend using [Nuxt plugins](/docs/4.x/guide/directory-structure/app/plugins). Use the `provide` function to create Nuxt plugins to make values and helper methods available in your Nuxt application across all composables and components.
33
+ `nuxtApp` is a runtime context that you can extend using [Nuxt plugins](/docs/4.x/directory-structure/app/plugins). Use the `provide` function to create Nuxt plugins to make values and helper methods available in your Nuxt application across all composables and components.
34
34
 
35
35
  `provide` function accepts `name` and `value` parameters.
36
36
 
@@ -46,7 +46,7 @@ As you can see in the example above, `$hello` has become the new and custom part
46
46
 
47
47
  ### `hook(name, cb)`
48
48
 
49
- Hooks available in `nuxtApp` allows you to customize the runtime aspects of your Nuxt application. You can use runtime hooks in Vue.js composables and [Nuxt plugins](/docs/4.x/guide/directory-structure/app/plugins) to hook into the rendering lifecycle.
49
+ Hooks available in `nuxtApp` allows you to customize the runtime aspects of your Nuxt application. You can use runtime hooks in Vue.js composables and [Nuxt plugins](/docs/4.x/directory-structure/app/plugins) to hook into the rendering lifecycle.
50
50
 
51
51
  `hook` function is useful for adding custom logic by hooking into the rendering lifecycle at a specific point. `hook` function is mostly used when creating Nuxt plugins.
52
52
 
@@ -84,8 +84,8 @@ await nuxtApp.callHook('my-plugin:init')
84
84
 
85
85
  Some useful methods:
86
86
  - [`component()`](https://vuejs.org/api/application#app-component) - Registers a global component if passing both a name string and a component definition, or retrieves an already registered one if only the name is passed.
87
- - [`directive()`](https://vuejs.org/api/application#app-directive) - Registers a global custom directive if passing both a name string and a directive definition, or retrieves an already registered one if only the name is passed[(example)](/docs/4.x/guide/directory-structure/app/plugins#vue-directives).
88
- - [`use()`](https://vuejs.org/api/application#app-use) - Installs a **[Vue.js Plugin](https://vuejs.org/guide/reusability/plugins)** [(example)](/docs/4.x/guide/directory-structure/app/plugins#vue-plugins).
87
+ - [`directive()`](https://vuejs.org/api/application#app-directive) - Registers a global custom directive if passing both a name string and a directive definition, or retrieves an already registered one if only the name is passed[(example)](/docs/4.x/directory-structure/app/plugins#vue-directives).
88
+ - [`use()`](https://vuejs.org/api/application#app-use) - Installs a **[Vue.js Plugin](https://vuejs.org/guide/reusability/plugins)** [(example)](/docs/4.x/directory-structure/app/plugins#vue-plugins).
89
89
 
90
90
  :read-more{icon="i-simple-icons-vuedotjs" to="https://vuejs.org/api/application.html#application-api"}
91
91
 
@@ -37,7 +37,7 @@ header.value = 'my-value'
37
37
  </template>
38
38
  ```
39
39
 
40
- We can use `useResponseHeader` for example in Nuxt [middleware](/docs/4.x/guide/directory-structure/app/middleware) to set a response header for all pages.
40
+ We can use `useResponseHeader` for example in Nuxt [middleware](/docs/4.x/directory-structure/app/middleware) to set a response header for all pages.
41
41
 
42
42
  ```ts [app/middleware/my-header-middleware.ts]
43
43
  export default defineNuxtRouteMiddleware((to, from) => {
@@ -1,8 +1,6 @@
1
1
  ---
2
2
  title: 'useRouteAnnouncer'
3
3
  description: This composable observes the page title changes and updates the announcer message accordingly.
4
- navigation:
5
- badge: New
6
4
  links:
7
5
  - label: Source
8
6
  icon: i-simple-icons-github
@@ -76,7 +76,7 @@ The `useRoute()` composable should only be used in the setup function of a Vue c
76
76
  This applies to any composable that uses `useRoute()` internally too.
77
77
  ::
78
78
 
79
- ::read-more{to="/docs/4.x/guide/directory-structure/app/middleware"}
79
+ ::read-more{to="/docs/4.x/directory-structure/app/middleware"}
80
80
  Read more about accessing the route in the middleware section.
81
81
  ::
82
82
 
@@ -49,7 +49,7 @@ router.resolve({ name: 'home' })
49
49
  ```
50
50
 
51
51
  ::note
52
- `router.addRoute()` adds route details into an array of routes and it is useful while building [Nuxt plugins](/docs/4.x/guide/directory-structure/app/plugins) while `router.push()` on the other hand, triggers a new navigation immediately and it is useful in pages, Vue components and composable.
52
+ `router.addRoute()` adds route details into an array of routes and it is useful while building [Nuxt plugins](/docs/4.x/directory-structure/app/plugins) while `router.push()` on the other hand, triggers a new navigation immediately and it is useful in pages, Vue components and composable.
53
53
  ::
54
54
 
55
55
  ## Based on History API
@@ -80,7 +80,7 @@ Read more about the browser's History API.
80
80
 
81
81
  However, Nuxt has a concept of **route middleware** that simplifies the implementation of navigation guards and provides a better developer experience.
82
82
 
83
- :read-more{to="/docs/4.x/guide/directory-structure/app/middleware"}
83
+ :read-more{to="/docs/4.x/directory-structure/app/middleware"}
84
84
 
85
85
  ## Promise and Error Handling
86
86
 
@@ -95,7 +95,7 @@ Any environment variables set within `.env` file are accessed using `process.env
95
95
  In **production runtime**, you should use platform environment variables and `.env` is not used.
96
96
  ::
97
97
 
98
- :read-more{to="/docs/4.x/guide/directory-structure/env"}
98
+ :read-more{to="/docs/4.x/directory-structure/env"}
99
99
 
100
100
  ## `app` namespace
101
101
 
@@ -11,7 +11,7 @@ links:
11
11
  Nuxt uses [ofetch](https://github.com/unjs/ofetch) to expose globally the `$fetch` helper for making HTTP requests within your Vue app or API routes.
12
12
 
13
13
  ::tip{icon="i-lucide-rocket"}
14
- During server-side rendering, calling `$fetch` to fetch your internal [API routes](/docs/4.x/guide/directory-structure/server) will directly call the relevant function (emulating the request), **saving an additional API call**.
14
+ During server-side rendering, calling `$fetch` to fetch your internal [API routes](/docs/4.x/directory-structure/server) will directly call the relevant function (emulating the request), **saving an additional API call**.
15
15
  ::
16
16
 
17
17
  ::note{color="blue" icon="i-lucide-info"}
@@ -9,7 +9,7 @@ links:
9
9
  ---
10
10
 
11
11
  ::warning
12
- `abortNavigation` is only usable inside a [route middleware handler](/docs/4.x/guide/directory-structure/app/middleware).
12
+ `abortNavigation` is only usable inside a [route middleware handler](/docs/4.x/directory-structure/app/middleware).
13
13
  ::
14
14
 
15
15
  ## Type
@@ -9,7 +9,7 @@ links:
9
9
  ---
10
10
 
11
11
  ::note
12
- Route middleware are navigation guards stored in the [`app/middleware/`](/docs/4.x/guide/directory-structure/app/middleware) directory of your Nuxt application (unless [set otherwise](/docs/4.x/api/nuxt-config#middleware)).
12
+ Route middleware are navigation guards stored in the [`app/middleware/`](/docs/4.x/directory-structure/app/middleware) directory of your Nuxt application (unless [set otherwise](/docs/4.x/api/nuxt-config#middleware)).
13
13
  ::
14
14
 
15
15
  ## Type
@@ -1,8 +1,6 @@
1
1
  ---
2
2
  title: "callOnce"
3
3
  description: "Run a given function or block of code once during SSR or CSR."
4
- navigation:
5
- badge: New
6
4
  links:
7
5
  - label: Source
8
6
  icon: i-simple-icons-github
@@ -16,7 +16,7 @@ export default defineNuxtPlugin((nuxtApp) => {
16
16
  })
17
17
  ```
18
18
 
19
- :read-more{to="/docs/4.x/guide/directory-structure/app/plugins#creating-plugins"}
19
+ :read-more{to="/docs/4.x/directory-structure/app/plugins#creating-plugins"}
20
20
 
21
21
  ## Type
22
22
 
@@ -42,19 +42,19 @@ 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/4.x/guide/going-further/internals#the-nuxtapp-interface) instance and can return a promise with a potential object with a [`provide`](/docs/4.x/guide/directory-structure/app/plugins#providing-helpers) property if you want to provide a helper on [`NuxtApp`](/docs/4.x/guide/going-further/internals#the-nuxtapp-interface) instance.
45
+ 1. **Function Plugin**: A function that receives the [`NuxtApp`](/docs/4.x/guide/going-further/internals#the-nuxtapp-interface) instance and can return a promise with a potential object with a [`provide`](/docs/4.x/directory-structure/app/plugins#providing-helpers) property if you want to provide a helper on [`NuxtApp`](/docs/4.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
- | Property | Type | Required | Description |
49
- | ------------------ | -------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
50
- | `name` | `string` | `false` | Optional name for the plugin, useful for debugging and dependency management. |
51
- | `enforce` | `'pre'` \| `'default'` \| `'post'` | `false` | Controls when the plugin runs relative to other plugins. |
52
- | `dependsOn` | `string[]` | `false` | Array of plugin names this plugin depends on. Ensures proper execution order. |
53
- | `order` | `number` | `false` | This allows more granular control over plugin order and should only be used by advanced users. **It overrides the value of `enforce` and is used to sort plugins.** |
54
- | `parallel` | `boolean` | `false` | Whether to execute the plugin in parallel with other parallel plugins. |
55
- | `setup` | `Plugin<T>`{lang="ts"} | `false` | The main plugin function, equivalent to a function plugin. |
56
- | `hooks` | `Partial<RuntimeNuxtHooks>`{lang="ts"} | `false` | Nuxt app runtime hooks to register directly. |
57
- | `env` | `{ islands?: boolean }`{lang="ts"} | `false` | Set this value to `false` if you don't want the plugin to run when rendering server-only or island components. |
48
+ | Property | Type | Required | Description |
49
+ |-------------|----------------------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
50
+ | `name` | `string` | `false` | Optional name for the plugin, useful for debugging and dependency management. |
51
+ | `enforce` | `'pre'` \| `'default'` \| `'post'` | `false` | Controls when the plugin runs relative to other plugins. |
52
+ | `dependsOn` | `string[]` | `false` | Array of plugin names this plugin depends on. Ensures proper execution order. |
53
+ | `order` | `number` | `false` | This allows more granular control over plugin order and should only be used by advanced users. **It overrides the value of `enforce` and is used to sort plugins.** |
54
+ | `parallel` | `boolean` | `false` | Whether to execute the plugin in parallel with other parallel plugins. |
55
+ | `setup` | `Plugin<T>`{lang="ts"} | `false` | The main plugin function, equivalent to a function plugin. |
56
+ | `hooks` | `Partial<RuntimeNuxtHooks>`{lang="ts"} | `false` | Nuxt app runtime hooks to register directly. |
57
+ | `env` | `{ islands?: boolean }`{lang="ts"} | `false` | Set this value to `false` if you don't want the plugin to run when rendering server-only or island components. |
58
58
 
59
59
  :video-accordion{title="Watch a video from Alexander Lichter about the Object Syntax for Nuxt plugins" videoId="2aXZyXB1QGQ"}
60
60
 
@@ -8,7 +8,7 @@ links:
8
8
  size: xs
9
9
  ---
10
10
 
11
- Route middleware are stored in the [`app/middleware/`](/docs/4.x/guide/directory-structure/app/middleware) of your Nuxt application (unless [set otherwise](/docs/4.x/api/nuxt-config#middleware)).
11
+ Route middleware are stored in the [`app/middleware/`](/docs/4.x/directory-structure/app/middleware) of your Nuxt application (unless [set otherwise](/docs/4.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 [`app/pages/`](/docs/4.x/guide/directory-structure/app/pages) directory (unless [set otherwise](/docs/4.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 [`app/pages/`](/docs/4.x/directory-structure/app/pages) directory (unless [set otherwise](/docs/4.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 [app/pages/some-page.vue]
14
14
  <script setup lang="ts">
@@ -18,7 +18,7 @@ definePageMeta({
18
18
  </script>
19
19
  ```
20
20
 
21
- :read-more{to="/docs/4.x/guide/directory-structure/app/pages#page-metadata"}
21
+ :read-more{to="/docs/4.x/directory-structure/app/pages#page-metadata"}
22
22
 
23
23
  ## Type
24
24
 
@@ -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 [`app/pages/` directory](/docs/4.x/guide/directory-structure/app/pages).
59
+ You may define a name for this page's route. By default, name is generated based on path inside the [`app/pages/` directory](/docs/4.x/directory-structure/app/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) | `Array<MiddlewareKey | NavigationGuard>`
106
106
 
107
- Define anonymous or named middleware directly within `definePageMeta`. Learn more about [route middleware](/docs/4.x/guide/directory-structure/app/middleware).
107
+ Define anonymous or named middleware directly within `definePageMeta`. Learn more about [route middleware](/docs/4.x/directory-structure/app/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/4.x/guide/directory-structure/app/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/4.x/directory-structure/app/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 [`app/layouts/` directory](/docs/4.x/guide/directory-structure/app/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 [`app/layouts/` directory](/docs/4.x/directory-structure/app/layouts). You can also disable the layout by setting the `layout` to `false`:
223
223
 
224
224
  ```vue [app/pages/some-page.vue]
225
225
  <script setup lang="ts">
@@ -68,7 +68,7 @@ export default defineNuxtRouteMiddleware((to, from) => {
68
68
 
69
69
  In this case, `navigateTo` will be executed but not returned, which may lead to unexpected behavior.
70
70
 
71
- :read-more{to="/docs/4.x/guide/directory-structure/app/middleware"}
71
+ :read-more{to="/docs/4.x/directory-structure/app/middleware"}
72
72
 
73
73
  ### Navigating to an External URL
74
74
 
@@ -217,14 +217,14 @@ An object accepting the following properties:
217
217
 
218
218
  - An object accepting the following properties:
219
219
 
220
- | Property | Type | Description |
221
- |----------|---------|--------------|
222
- | `popup` | `boolean` | Requests a minimal popup window instead of a new tab, with UI features decided by the browser. |
223
- | `width` or `innerWidth` | `number` | Specifies the content area's width (minimum 100 pixels), including scrollbars. |
224
- | `height` or `innerHeight` | `number` | Specifies the content area's height (minimum 100 pixels), including scrollbars. |
225
- | `left` or `screenX` | `number` | Sets the horizontal position of the new window relative to the left edge of the screen. |
226
- | `top` or `screenY` | `number` | Sets the vertical position of the new window relative to the top edge of the screen. |
227
- | `noopener` | `boolean` | Prevents the new window from accessing the originating window via `window.opener`. |
228
- | `noreferrer` | `boolean` | Prevents the Referer header from being sent and implicitly enables `noopener`. |
220
+ | Property | Type | Description |
221
+ |---------------------------|-----------|------------------------------------------------------------------------------------------------|
222
+ | `popup` | `boolean` | Requests a minimal popup window instead of a new tab, with UI features decided by the browser. |
223
+ | `width` or `innerWidth` | `number` | Specifies the content area's width (minimum 100 pixels), including scrollbars. |
224
+ | `height` or `innerHeight` | `number` | Specifies the content area's height (minimum 100 pixels), including scrollbars. |
225
+ | `left` or `screenX` | `number` | Sets the horizontal position of the new window relative to the left edge of the screen. |
226
+ | `top` or `screenY` | `number` | Sets the vertical position of the new window relative to the top edge of the screen. |
227
+ | `noopener` | `boolean` | Prevents the new window from accessing the originating window via `window.opener`. |
228
+ | `noreferrer` | `boolean` | Prevents the Referer header from being sent and implicitly enables `noopener`. |
229
229
 
230
230
  Refer to the [documentation](https://developer.mozilla.org/en-US/docs/Web/API/Window/open#windowfeatures) for more detailed information on the **windowFeatures** properties.
@@ -1,8 +1,6 @@
1
1
  ---
2
2
  title: "refreshCookie"
3
3
  description: "Refresh useCookie values manually when a cookie has changed"
4
- navigation:
5
- badge: New
6
4
  links:
7
5
  - label: Source
8
6
  icon: i-simple-icons-github
@@ -9,7 +9,7 @@ links:
9
9
  ---
10
10
 
11
11
  ::note
12
- Updates the [`app.config`](/docs/4.x/guide/directory-structure/app/app-config) using deep assignment. Existing (nested) properties will be preserved.
12
+ Updates the [`app.config`](/docs/4.x/directory-structure/app/app-config) using deep assignment. Existing (nested) properties will be preserved.
13
13
  ::
14
14
 
15
15
  ## Usage
@@ -25,4 +25,4 @@ updateAppConfig(newAppConfig)
25
25
  console.log(appConfig) // { foo: 'baz' }
26
26
  ```
27
27
 
28
- :read-more{to="/docs/4.x/guide/directory-structure/app/app-config"}
28
+ :read-more{to="/docs/4.x/directory-structure/app/app-config"}
@@ -14,23 +14,23 @@ npx nuxt add <TEMPLATE> <NAME> [--cwd=<directory>] [--logLevel=<silent|info|verb
14
14
  ```
15
15
  <!--/add-cmd-->
16
16
 
17
- ### Arguments
17
+ ## Arguments
18
18
 
19
19
  <!--add-args-->
20
- Argument | Description
21
- --- | ---
22
- `TEMPLATE` | Specify which template to generate (options: <api\|app\|app-config\|component\|composable\|error\|layer\|layout\|middleware\|module\|page\|plugin\|server-middleware\|server-plugin\|server-route\|server-util>)
23
- `NAME` | Specify name of the generated file
20
+ | Argument | Description |
21
+ |------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
22
+ | `TEMPLATE` | Specify which template to generate (options: <api\|app\|app-config\|component\|composable\|error\|layer\|layout\|middleware\|module\|page\|plugin\|server-middleware\|server-plugin\|server-route\|server-util>) |
23
+ | `NAME` | Specify name of the generated file |
24
24
  <!--/add-args-->
25
25
 
26
26
  ### Options
27
27
 
28
28
  <!--add-opts-->
29
- Option | Default | Description
30
- --- | --- | ---
31
- `--cwd=<directory>` | `.` | Specify the working directory
32
- `--logLevel=<silent\|info\|verbose>` | | Specify build-time log level
33
- `--force` | `false` | Force override file if it already exists
29
+ | Option | Default | Description |
30
+ |--------------------------------------|---------|------------------------------------------|
31
+ | `--cwd=<directory>` | `.` | Specify the working directory |
32
+ | `--logLevel=<silent\|info\|verbose>` | | Specify build-time log level |
33
+ | `--force` | `false` | Force override file if it already exists |
34
34
  <!--/add-opts-->
35
35
 
36
36
  **Modifiers:**
@@ -0,0 +1,42 @@
1
+ ---
2
+ title: "nuxt analyze"
3
+ description: "Analyze the production bundle or your Nuxt application."
4
+ links:
5
+ - label: Source
6
+ icon: i-simple-icons-github
7
+ to: https://github.com/nuxt/cli/blob/main/packages/nuxi/src/commands/analyze.ts
8
+ size: xs
9
+ ---
10
+
11
+ <!--analyze-cmd-->
12
+ ```bash [Terminal]
13
+ npx nuxt analyze [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--dotenv] [-e, --extends=<layer-name>] [--name=<name>] [--no-serve]
14
+ ```
15
+ <!--/analyze-cmd-->
16
+
17
+ The `analyze` command builds Nuxt and analyzes the production bundle (experimental).
18
+
19
+ ## Arguments
20
+
21
+ <!--analyze-args-->
22
+ | Argument | Description |
23
+ |---------------|------------------------------------------------|
24
+ | `ROOTDIR="."` | Specifies the working directory (default: `.`) |
25
+ <!--/analyze-args-->
26
+
27
+ ## Options
28
+
29
+ <!--analyze-opts-->
30
+ | Option | Default | Description |
31
+ |--------------------------------------|-----------|----------------------------------------------------------------------------------|
32
+ | `--cwd=<directory>` | | Specify the working directory, this takes precedence over ROOTDIR (default: `.`) |
33
+ | `--logLevel=<silent\|info\|verbose>` | | Specify build-time log level |
34
+ | `--dotenv` | | Path to `.env` file to load, relative to the root directory |
35
+ | `-e, --extends=<layer-name>` | | Extend from a Nuxt layer |
36
+ | `--name=<name>` | `default` | Name of the analysis |
37
+ | `--no-serve` | | Skip serving the analysis results |
38
+ <!--/analyze-opts-->
39
+
40
+ ::note
41
+ This command sets `process.env.NODE_ENV` to `production`.
42
+ ::
@@ -0,0 +1,42 @@
1
+ ---
2
+ title: 'nuxt build-module'
3
+ description: 'Nuxt command to build your Nuxt module before publishing.'
4
+ links:
5
+ - label: Source
6
+ icon: i-simple-icons-github
7
+ to: https://github.com/nuxt/module-builder/blob/main/src/cli.ts
8
+ size: xs
9
+ ---
10
+
11
+ <!--build-module-cmd-->
12
+ ```bash [Terminal]
13
+ npx nuxt build-module [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--build] [--stub] [--sourcemap] [--prepare]
14
+ ```
15
+ <!--/build-module-cmd-->
16
+
17
+ The `build-module` command runs `@nuxt/module-builder` to generate `dist` directory within your `rootDir` that contains the full build for your **nuxt-module**.
18
+
19
+ ## Arguments
20
+
21
+ <!--build-module-args-->
22
+ | Argument | Description |
23
+ |---------------|------------------------------------------------|
24
+ | `ROOTDIR="."` | Specifies the working directory (default: `.`) |
25
+ <!--/build-module-args-->
26
+
27
+ ## Options
28
+
29
+ <!--build-module-opts-->
30
+ | Option | Default | Description |
31
+ |--------------------------------------|---------|----------------------------------------------------------------------------------|
32
+ | `--cwd=<directory>` | | Specify the working directory, this takes precedence over ROOTDIR (default: `.`) |
33
+ | `--logLevel=<silent\|info\|verbose>` | | Specify build-time log level |
34
+ | `--build` | `false` | Build module for distribution |
35
+ | `--stub` | `false` | Stub dist instead of actually building it for development |
36
+ | `--sourcemap` | `false` | Generate sourcemaps |
37
+ | `--prepare` | `false` | Prepare module for local development |
38
+ <!--/build-module-opts-->
39
+
40
+ ::read-more{to="https://github.com/nuxt/module-builder" icon="i-simple-icons-github" target="\_blank"}
41
+ Read more about `@nuxt/module-builder`.
42
+ ::
@@ -0,0 +1,47 @@
1
+ ---
2
+ title: "nuxt build"
3
+ description: "Build your Nuxt application."
4
+ links:
5
+ - label: Source
6
+ icon: i-simple-icons-github
7
+ to: https://github.com/nuxt/cli/blob/main/packages/nuxi/src/commands/build.ts
8
+ size: xs
9
+ ---
10
+
11
+ <!--build-cmd-->
12
+ ```bash [Terminal]
13
+ npx nuxt build [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--prerender] [--preset] [--dotenv] [--envName] [-e, --extends=<layer-name>]
14
+ ```
15
+ <!--/build-cmd-->
16
+
17
+ The `build` command creates a `.output` directory with all your application, server and dependencies ready for production.
18
+
19
+ ## Arguments
20
+
21
+ <!--build-args-->
22
+ | Argument | Description |
23
+ |---------------|------------------------------------------------|
24
+ | `ROOTDIR="."` | Specifies the working directory (default: `.`) |
25
+ <!--/build-args-->
26
+
27
+ ## Options
28
+
29
+ <!--build-opts-->
30
+ | Option | Default | Description |
31
+ |--------------------------------------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------|
32
+ | `--cwd=<directory>` | | Specify the working directory, this takes precedence over ROOTDIR (default: `.`) |
33
+ | `--logLevel=<silent\|info\|verbose>` | | Specify build-time log level |
34
+ | `--prerender` | | Build Nuxt and prerender static routes |
35
+ | `--preset` | | Nitro server preset |
36
+ | `--dotenv` | | Path to `.env` file to load, relative to the root directory |
37
+ | `--envName` | | The environment to use when resolving configuration overrides (default is `production` when building, and `development` when running the dev server) |
38
+ | `-e, --extends=<layer-name>` | | Extend from a Nuxt layer |
39
+ <!--/build-opts-->
40
+
41
+ ::note
42
+ This command sets `process.env.NODE_ENV` to `production`.
43
+ ::
44
+
45
+ ::note
46
+ `--prerender` will always set the `preset` to `static`
47
+ ::
@@ -24,15 +24,15 @@ The `cleanup` command removes common generated Nuxt files and caches, including:
24
24
  ## Arguments
25
25
 
26
26
  <!--cleanup-args-->
27
- Argument | Description
28
- --- | ---
29
- `ROOTDIR="."` | Specifies the working directory (default: `.`)
27
+ | Argument | Description |
28
+ |---------------|------------------------------------------------|
29
+ | `ROOTDIR="."` | Specifies the working directory (default: `.`) |
30
30
  <!--/cleanup-args-->
31
31
 
32
32
  ## Options
33
33
 
34
34
  <!--cleanup-opts-->
35
- Option | Default | Description
36
- --- | --- | ---
37
- `--cwd=<directory>` | | Specify the working directory, this takes precedence over ROOTDIR (default: `.`)
35
+ | Option | Default | Description |
36
+ |---------------------|---------|----------------------------------------------------------------------------------|
37
+ | `--cwd=<directory>` | | Specify the working directory, this takes precedence over ROOTDIR (default: `.`) |
38
38
  <!--/cleanup-opts-->
@@ -0,0 +1,60 @@
1
+ ---
2
+ title: 'nuxt dev'
3
+ description: The dev command starts a development server with hot module replacement at http://localhost:3000
4
+ links:
5
+ - label: Source
6
+ icon: i-simple-icons-github
7
+ to: https://github.com/nuxt/cli/blob/main/packages/nuxi/src/commands/dev.ts
8
+ size: xs
9
+ ---
10
+
11
+ <!--dev-cmd-->
12
+ ```bash [Terminal]
13
+ npx nuxt dev [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--dotenv] [--envName] [-e, --extends=<layer-name>] [--clear] [--no-f, --no-fork] [-p, --port] [-h, --host] [--clipboard] [-o, --open] [--https] [--publicURL] [--qr] [--public] [--tunnel] [--sslCert] [--sslKey]
14
+ ```
15
+ <!--/dev-cmd-->
16
+
17
+ The `dev` command starts a development server with hot module replacement at [http://localhost:3000](https://localhost:3000)
18
+
19
+ ## Arguments
20
+
21
+ <!--dev-args-->
22
+ | Argument | Description |
23
+ |---------------|------------------------------------------------|
24
+ | `ROOTDIR="."` | Specifies the working directory (default: `.`) |
25
+ <!--/dev-args-->
26
+
27
+ ## Options
28
+
29
+ <!--dev-opts-->
30
+ | Option | Default | Description |
31
+ |--------------------------------------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------|
32
+ | `--cwd=<directory>` | | Specify the working directory, this takes precedence over ROOTDIR (default: `.`) |
33
+ | `--logLevel=<silent\|info\|verbose>` | | Specify build-time log level |
34
+ | `--dotenv` | | Path to `.env` file to load, relative to the root directory |
35
+ | `--envName` | | The environment to use when resolving configuration overrides (default is `production` when building, and `development` when running the dev server) |
36
+ | `-e, --extends=<layer-name>` | | Extend from a Nuxt layer |
37
+ | `--clear` | `false` | Clear console on restart |
38
+ | `--no-f, --no-fork` | | Disable forked mode |
39
+ | `-p, --port` | | Port to listen on (default: `NUXT_PORT \|\| NITRO_PORT \|\| PORT \|\| nuxtOptions.devServer.port`) |
40
+ | `-h, --host` | | Host to listen on (default: `NUXT_HOST \|\| NITRO_HOST \|\| HOST \|\| nuxtOptions.devServer?.host`) |
41
+ | `--clipboard` | `false` | Copy the URL to the clipboard |
42
+ | `-o, --open` | `false` | Open the URL in the browser |
43
+ | `--https` | | Enable HTTPS |
44
+ | `--publicURL` | | Displayed public URL (used for QR code) |
45
+ | `--qr` | | Display The QR code of public URL when available |
46
+ | `--public` | | Listen to all network interfaces |
47
+ | `--tunnel` | | Open a tunnel using https://github.com/unjs/untun |
48
+ | `--sslCert` | | (DEPRECATED) Use `--https.cert` instead. |
49
+ | `--sslKey` | | (DEPRECATED) Use `--https.key` instead. |
50
+ <!--/dev-opts-->
51
+
52
+ The port and host can also be set via NUXT_PORT, PORT, NUXT_HOST or HOST environment variables.
53
+
54
+ Additionally to the above options, `@nuxt/cli` can pass options through to `listhen`, e.g. `--no-qr` to turn off the dev server QR code. You can find the list of `listhen` options in the [unjs/listhen](https://github.com/unjs/listhen) docs.
55
+
56
+ This command sets `process.env.NODE_ENV` to `development`.
57
+
58
+ ::note
59
+ If you are using a self-signed certificate in development, you will need to set `NODE_TLS_REJECT_UNAUTHORIZED=0` in your environment.
60
+ ::
@@ -19,18 +19,18 @@ Running `nuxt devtools enable` will install the Nuxt DevTools globally, and also
19
19
  ## Arguments
20
20
 
21
21
  <!--devtools-args-->
22
- Argument | Description
23
- --- | ---
24
- `COMMAND` | Command to run (options: <enable\|disable>)
25
- `ROOTDIR="."` | Specifies the working directory (default: `.`)
22
+ | Argument | Description |
23
+ |---------------|------------------------------------------------|
24
+ | `COMMAND` | Command to run (options: <enable\|disable>) |
25
+ | `ROOTDIR="."` | Specifies the working directory (default: `.`) |
26
26
  <!--/devtools-args-->
27
27
 
28
28
  ## Options
29
29
 
30
30
  <!--devtools-opts-->
31
- Option | Default | Description
32
- --- | --- | ---
33
- `--cwd=<directory>` | | Specify the working directory, this takes precedence over ROOTDIR (default: `.`)
31
+ | Option | Default | Description |
32
+ |---------------------|---------|----------------------------------------------------------------------------------|
33
+ | `--cwd=<directory>` | | Specify the working directory, this takes precedence over ROOTDIR (default: `.`) |
34
34
  <!--/devtools-opts-->
35
35
 
36
36
  ::read-more{icon="i-simple-icons-nuxtdotjs" to="https://devtools.nuxt.com" target="\_blank"}