@nuxt/docs-nightly 4.0.0-29162105.8c587084 → 4.0.0-29163786.9c7398ba

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 (69) hide show
  1. package/1.getting-started/01.introduction.md +3 -3
  2. package/1.getting-started/03.configuration.md +1 -1
  3. package/1.getting-started/07.routing.md +1 -1
  4. package/1.getting-started/10.data-fetching.md +1 -1
  5. package/1.getting-started/11.state-management.md +1 -1
  6. package/1.getting-started/12.error-handling.md +1 -1
  7. package/1.getting-started/15.prerendering.md +7 -7
  8. package/1.getting-started/16.deployment.md +2 -2
  9. package/1.getting-started/18.upgrade.md +51 -9
  10. package/2.guide/1.concepts/3.rendering.md +3 -3
  11. package/2.guide/1.concepts/5.modules.md +1 -1
  12. package/2.guide/1.concepts/8.typescript.md +6 -6
  13. package/2.guide/1.concepts/9.code-style.md +1 -1
  14. package/2.guide/2.directory-structure/1.app/.navigation.yml +5 -0
  15. package/2.guide/2.directory-structure/{1.composables.md → 1.app/1.composables.md} +1 -1
  16. package/2.guide/2.directory-structure/{1.pages.md → 1.app/1.pages.md} +2 -2
  17. package/2.guide/2.directory-structure/1.content.md +1 -1
  18. package/2.guide/2.directory-structure/1.server.md +1 -1
  19. package/2.guide/2.directory-structure/2.env.md +4 -4
  20. package/2.guide/3.going-further/1.events.md +1 -1
  21. package/2.guide/3.going-further/1.experimental-features.md +1 -1
  22. package/2.guide/3.going-further/1.internals.md +2 -2
  23. package/2.guide/3.going-further/10.runtime-config.md +1 -1
  24. package/2.guide/3.going-further/11.nightly-release-channel.md +2 -6
  25. package/2.guide/3.going-further/3.modules.md +3 -3
  26. package/2.guide/3.going-further/9.debugging.md +1 -5
  27. package/2.guide/4.recipes/1.custom-routing.md +5 -5
  28. package/2.guide/4.recipes/4.sessions-and-authentication.md +2 -2
  29. package/3.api/1.components/10.nuxt-picture.md +1 -1
  30. package/3.api/1.components/9.nuxt-img.md +1 -1
  31. package/3.api/2.composables/use-async-data.md +1 -1
  32. package/3.api/2.composables/use-cookie.md +5 -4
  33. package/3.api/2.composables/use-fetch.md +1 -1
  34. package/3.api/2.composables/use-preview-mode.md +3 -3
  35. package/3.api/3.utils/define-page-meta.md +1 -1
  36. package/3.api/4.commands/add.md +20 -20
  37. package/3.api/4.commands/analyze.md +2 -2
  38. package/3.api/4.commands/build-module.md +2 -2
  39. package/3.api/4.commands/build.md +2 -2
  40. package/3.api/4.commands/cleanup.md +2 -2
  41. package/3.api/4.commands/dev.md +3 -3
  42. package/3.api/4.commands/devtools.md +3 -3
  43. package/3.api/4.commands/generate.md +3 -3
  44. package/3.api/4.commands/info.md +2 -2
  45. package/3.api/4.commands/init.md +3 -3
  46. package/3.api/4.commands/module.md +8 -8
  47. package/3.api/4.commands/prepare.md +2 -2
  48. package/3.api/4.commands/preview.md +3 -3
  49. package/3.api/4.commands/typecheck.md +2 -2
  50. package/3.api/4.commands/upgrade.md +2 -2
  51. package/3.api/5.kit/11.nitro.md +48 -1
  52. package/3.api/5.kit/4.autoimports.md +8 -8
  53. package/3.api/6.advanced/1.hooks.md +1 -1
  54. package/3.api/6.nuxt-config.md +2932 -3
  55. package/5.community/4.contribution.md +1 -1
  56. package/5.community/6.roadmap.md +17 -12
  57. package/5.community/7.changelog.md +1 -1
  58. package/7.migration/2.configuration.md +2 -2
  59. package/7.migration/7.component-options.md +1 -1
  60. package/package.json +1 -1
  61. /package/2.guide/2.directory-structure/{1.assets.md → 1.app/1.assets.md} +0 -0
  62. /package/2.guide/2.directory-structure/{1.components.md → 1.app/1.components.md} +0 -0
  63. /package/2.guide/2.directory-structure/{1.layouts.md → 1.app/1.layouts.md} +0 -0
  64. /package/2.guide/2.directory-structure/{1.middleware.md → 1.app/1.middleware.md} +0 -0
  65. /package/2.guide/2.directory-structure/{1.plugins.md → 1.app/1.plugins.md} +0 -0
  66. /package/2.guide/2.directory-structure/{1.utils.md → 1.app/1.utils.md} +0 -0
  67. /package/2.guide/2.directory-structure/{3.app-config.md → 1.app/3.app-config.md} +0 -0
  68. /package/2.guide/2.directory-structure/{3.app.md → 1.app/3.app.md} +0 -0
  69. /package/2.guide/2.directory-structure/{3.error.md → 1.app/3.error.md} +0 -0
@@ -52,7 +52,7 @@ Note that `fix:` and `feat:` are for **actual code changes** (that might affect
52
52
 
53
53
  * ~~`fix: typo`~~ -> `docs: fix typo`
54
54
 
55
- If you are working in a project with a monorepo, like `nuxt/nuxt`, ensure that you specify the main scope of your commit in brackets. For example: `feat(nuxi): add 'do-magic' command`.
55
+ If you are working in a project with a monorepo, like `nuxt/nuxt`, ensure that you specify the main scope of your commit in brackets. For example: `feat(kit): add 'addMagicStuff' utility`.
56
56
 
57
57
  #### Making the Pull Request
58
58
 
@@ -30,8 +30,8 @@ Check [Discussions](https://github.com/nuxt/nuxt/discussions) and [RFCs](https:/
30
30
 
31
31
  Milestone | Expected date | Notes | Description
32
32
  -------------|---------------|------------------------------------------------------------------------|-----------------------
33
- SEO & PWA | 2024 | [nuxt/nuxt#18395](https://github.com/nuxt/nuxt/discussions/18395) | Migrating from [nuxt-community/pwa-module](https://github.com/nuxt-community/pwa-module) for built-in SEO utils and service worker support
34
- Assets | 2024 | [nuxt/nuxt#22012](https://github.com/nuxt/nuxt/discussions/22012) | Allow developers and modules to handle loading third-party assets.
33
+ SEO & PWA | 2025 | [nuxt/nuxt#18395](https://github.com/nuxt/nuxt/discussions/18395) | Migrating from [nuxt-community/pwa-module](https://github.com/nuxt-community/pwa-module) for built-in SEO utils and service worker support
34
+ Assets | 2025 | [nuxt/nuxt#22012](https://github.com/nuxt/nuxt/discussions/22012) | Allow developers and modules to handle loading third-party assets.
35
35
  Translations | - | [nuxt/translations#4](https://github.com/nuxt/translations/discussions/4) ([request access](https://github.com/nuxt/nuxt/discussions/16054)) | A collaborative project for a stable translation process for Nuxt docs. Currently pending for ideas and documentation tooling support (content v2 with remote sources).
36
36
 
37
37
  ## Core Modules Roadmap
@@ -40,33 +40,38 @@ In addition to the Nuxt framework, there are modules that are vital for the ecos
40
40
 
41
41
  Module | Status | Nuxt Support | Repository | Description
42
42
  ------------------------------------|---------------------|--------------|------------|-------------------
43
- [Scripts](https://scripts.nuxt.com) | Public Beta | 3.x | [nuxt/scripts](https://github.com/nuxt/scripts) | Easy 3rd party script management.
44
- Auth Utils | Planned | 3.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 | 3.x | `nuxt/a11y` to be announced | Accessibility hinting and utilities [nuxt/nuxt#23255](https://github.com/nuxt/nuxt/issues/23255)
46
- Hints | Planned | 3.x | `nuxt/hints` to be announced | Guidance and suggestions for enhancing development practices.
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.
47
47
 
48
48
  ## Release Cycle
49
49
 
50
50
  Since January 2023, we've adopted a consistent release cycle for Nuxt, following [semver](https://semver.org). We aim for major framework releases every year, with an expectation of patch releases every week or so and minor releases every month or so. They should never contain breaking changes except within options clearly marked as `experimental`.
51
51
 
52
+ We are planning a slight variation from this plan for Nuxt 4 and Nuxt 5. Nuxt 4 will be a stability-focused release containing all `compatibilityVersion: 4` features, and will be followed shortly by Nuxt 5 which will include an upgrade to Nitro v3 and additional changes.
53
+
54
+ This approach separates breaking changes into manageable phases, allowing for better ecosystem testing and smoother migrations.
55
+
52
56
  ### Ongoing Support for Nuxt
53
57
 
54
- Going forward from v3, we commit to support each major version of Nuxt for a minimum of a year after the last release, and to providing an upgrade path for current users at that point.
58
+ We commit to support each major version of Nuxt for a minimum of six months after the release of the next major version, and to providing an upgrade path for current users at that point.
55
59
 
56
60
  ### Current Packages
57
61
 
58
62
  The current active version of [Nuxt](https://nuxt.com) is **v3** which is available as `nuxt` on npm with the `latest` tag.
59
63
 
60
- Nuxt 2 is in maintenance mode and is available on npm with the `2x` tag. It will reach End of Life (EOL) on June 30, 2024.
64
+ Nuxt 2 is in maintenance mode and is available on npm with the `2x` tag. It reached End of Life (EOL) on June 30, 2024.
61
65
 
62
66
  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).
63
67
 
64
68
  Release | | Initial release | End Of Life | Docs
65
69
  ----------------------------------------|---------------------------------------------------------------------------------------------------|-----------------|--------------|-------
66
- **4.x** (scheduled) | | approximately 1 month after release of nitro v3 | |  
67
- **3.x** (stable) | <a href="https://npmjs.com/package/nuxt"><img alt="Nuxt latest 3.x version" src="https://flat.badgen.net/npm/v/nuxt?label=" class="not-prose"></a> | 2022-11-16 | TBA | [nuxt.com](/docs)
68
- **2.x** (unsupported) | <a href="https://www.npmjs.com/package/nuxt?activeTab=versions"><img alt="Nuxt 2.x version" src="https://flat.badgen.net/npm/v/nuxt/2x?label=" class="not-prose"></a> | 2018-09-21 | 2024-06-30 | [v2.nuxt.com](https://v2.nuxt.com/docs)
69
- **1.x** (unsupported) | <a href="https://www.npmjs.com/package/nuxt?activeTab=versions"><img alt="Nuxt 1.x version" src="https://flat.badgen.net/npm/v/nuxt/1x?label=" class="not-prose"></a> | 2018-01-08 | 2019-09-21 | &nbsp;
70
+ **5.x** (scheduled) | | Q4 2025 (estimated) | TBA | &nbsp;
71
+ **4.x** (scheduled) | | 2025-06-30 (planned) | 6 months after 5.x release | &nbsp;
72
+ **3.x** (stable) | <a href="https://npmjs.com/package/nuxt"><img alt="Nuxt latest 3.x version" src="https://flat.badgen.net/npm/v/nuxt?label=" class="not-prose"></a> | 2022-11-16 | 2025-12-31 (TBC) | [nuxt.com](/docs)
73
+ **2.x** (unsupported) | <a href="https://www.npmjs.com/package/nuxt?activeTab=versions"><img alt="Nuxt 2.x version" src="https://flat.badgen.net/npm/v/nuxt/2x?label=" class="not-prose"></a> | 2018-09-21 | 2024-06-30 | [v2.nuxt.com](https://v2.nuxt.com/docs)
74
+ **1.x** (unsupported) | <a href="https://www.npmjs.com/package/nuxt?activeTab=versions"><img alt="Nuxt 1.x version" src="https://flat.badgen.net/npm/v/nuxt/1x?label=" class="not-prose"></a> | 2018-01-08 | 2019-09-21 | &nbsp;
70
75
 
71
76
  ### Support Status
72
77
 
@@ -23,7 +23,7 @@ navigation.icon: i-lucide-bell-dot
23
23
  target: _blank
24
24
  ui.icon.base: text-black dark:text-white
25
25
  ---
26
- Nuxt CLI (`nuxi`) releases.
26
+ Nuxt CLI (`@nuxt/cli`) releases.
27
27
  ::
28
28
  ::card
29
29
  ---
@@ -147,7 +147,7 @@ It will be much easier to migrate your application if you use Nuxt's TypeScript
147
147
  You can read more about Nuxt's TypeScript support [in the docs](/docs/guide/concepts/typescript).
148
148
 
149
149
  ::note
150
- Nuxt can type-check your app using [`vue-tsc`](https://github.com/vuejs/language-tools/tree/master/packages/tsc) with `nuxi typecheck` command.
150
+ Nuxt can type-check your app using [`vue-tsc`](https://github.com/vuejs/language-tools/tree/master/packages/tsc) with `nuxt typecheck` command.
151
151
  ::
152
152
 
153
153
  ### Migration
@@ -160,7 +160,7 @@ Nuxt can type-check your app using [`vue-tsc`](https://github.com/vuejs/language
160
160
  }
161
161
  ```
162
162
 
163
- 1. Run `npx nuxi prepare` to generate `.nuxt/tsconfig.json`.
163
+ 1. Run `npx nuxt prepare` to generate `.nuxt/tsconfig.json`.
164
164
  1. Install Volar following the instructions in the [docs](/docs/getting-started/introduction#prerequisites).
165
165
 
166
166
  ## Vue Changes
@@ -103,7 +103,7 @@ This feature is not yet supported in Nuxt 3.
103
103
 
104
104
  ## `scrollToTop`
105
105
 
106
- This feature is not yet supported in Nuxt 3. If you want to overwrite the default scroll behavior of `vue-router`, you can do so in `~/app/router.options.ts` (see [docs](/docs/guide/recipes/custom-routing#router-options)) for more info.
106
+ This feature is not yet supported in Nuxt 3. If you want to overwrite the default scroll behavior of `vue-router`, you can do so in an `~/router.options.ts` (see [docs](/docs/guide/recipes/custom-routing#router-options)) for more info.
107
107
  Similar to `key`, specify it within the [`definePageMeta`](/docs/api/utils/define-page-meta) compiler macro.
108
108
 
109
109
  ```diff [pages/index.vue]
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@nuxt/docs-nightly",
3
- "version": "4.0.0-29162105.8c587084",
3
+ "version": "4.0.0-29163786.9c7398ba",
4
4
  "repository": {
5
5
  "type": "git",
6
6
  "url": "git+https://github.com/nuxt/nuxt.git",