@nuxt/docs-nightly 4.2.2-29381721.51356a46 → 4.2.2-29385650.ab3dd9a8
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.
- package/1.getting-started/01.introduction.md +1 -1
- package/1.getting-started/03.configuration.md +5 -5
- package/1.getting-started/04.views.md +5 -5
- package/1.getting-started/05.assets.md +7 -7
- package/1.getting-started/06.styling.md +5 -5
- package/1.getting-started/07.routing.md +7 -7
- package/1.getting-started/08.seo-meta.md +3 -3
- package/1.getting-started/09.transitions.md +6 -6
- package/1.getting-started/10.data-fetching.md +2 -2
- package/1.getting-started/11.state-management.md +2 -2
- package/1.getting-started/12.error-handling.md +3 -3
- package/1.getting-started/13.server.md +2 -2
- package/1.getting-started/14.layers.md +3 -3
- package/1.getting-started/16.deployment.md +1 -1
- package/1.getting-started/17.testing.md +1 -1
- package/1.getting-started/18.upgrade.md +6 -6
- package/2.directory-structure/0.nuxt.md +1 -1
- package/2.directory-structure/0.output.md +1 -1
- package/2.directory-structure/1.app/1.assets.md +2 -2
- package/2.directory-structure/1.app/1.components.md +2 -2
- package/2.directory-structure/1.app/1.composables.md +2 -2
- package/2.directory-structure/1.app/1.layouts.md +3 -3
- package/2.directory-structure/1.app/1.middleware.md +1 -1
- package/2.directory-structure/1.app/1.pages.md +7 -7
- package/2.directory-structure/1.app/1.plugins.md +2 -2
- package/2.directory-structure/1.app/1.utils.md +3 -3
- package/2.directory-structure/1.app/3.app.md +4 -4
- package/2.directory-structure/1.content.md +1 -1
- package/2.directory-structure/1.modules.md +1 -1
- package/2.directory-structure/1.node_modules.md +1 -1
- package/2.directory-structure/1.server.md +3 -3
- package/2.directory-structure/1.shared.md +3 -3
- package/2.directory-structure/2.env.md +2 -2
- package/2.directory-structure/2.nuxtignore.md +1 -1
- package/2.directory-structure/2.nuxtrc.md +1 -1
- package/2.directory-structure/3.nuxt-config.md +1 -1
- package/2.directory-structure/3.package.md +1 -1
- package/2.directory-structure/index.md +24 -24
- package/3.guide/1.concepts/{3.rendering.md → 1.rendering.md} +1 -27
- package/3.guide/1.concepts/{2.vuejs-development.md → 10.vuejs-development.md} +4 -3
- package/3.guide/1.concepts/{10.nuxt-lifecycle.md → 2.nuxt-lifecycle.md} +32 -25
- package/3.guide/1.concepts/{1.auto-imports.md → 3.auto-imports.md} +5 -5
- package/3.guide/1.concepts/4.server-engine.md +3 -3
- package/3.guide/1.concepts/5.modules.md +1 -1
- package/3.guide/1.concepts/7.esm.md +1 -0
- package/3.guide/1.concepts/8.typescript.md +4 -4
- package/3.guide/2.best-practices/performance.md +2 -2
- package/3.guide/3.ai/.navigation.yml +3 -0
- package/3.guide/3.ai/1.mcp.md +255 -0
- package/3.guide/3.ai/2.llms-txt.md +65 -0
- package/3.guide/{3.recipes → 4.recipes}/1.custom-routing.md +1 -1
- package/3.guide/{3.recipes → 4.recipes}/2.vite-plugin.md +1 -1
- package/3.guide/{3.recipes → 4.recipes}/3.custom-usefetch.md +1 -1
- package/3.guide/{3.recipes → 4.recipes}/4.sessions-and-authentication.md +1 -1
- package/3.guide/{4.going-further → 5.going-further}/1.events.md +2 -3
- package/3.guide/{4.going-further → 5.going-further}/1.experimental-features.md +4 -4
- package/3.guide/{4.going-further → 5.going-further}/1.internals.md +3 -2
- package/3.guide/{4.going-further → 5.going-further}/10.runtime-config.md +2 -2
- package/3.guide/{4.going-further → 5.going-further}/2.hooks.md +2 -2
- package/3.guide/{4.going-further → 5.going-further}/3.modules.md +2 -2
- package/3.guide/{4.going-further → 5.going-further}/6.nuxt-app.md +3 -3
- package/3.guide/{4.going-further → 5.going-further}/7.layers.md +11 -11
- package/4.api/1.components/12.nuxt-route-announcer.md +1 -1
- package/4.api/1.components/2.nuxt-page.md +2 -2
- package/4.api/1.components/3.nuxt-layout.md +5 -5
- package/4.api/1.components/5.nuxt-loading-indicator.md +1 -1
- package/4.api/1.components/7.nuxt-welcome.md +2 -2
- package/4.api/2.composables/use-app-config.md +1 -1
- package/4.api/2.composables/use-nuxt-app.md +4 -4
- package/4.api/2.composables/use-response-header.md +1 -1
- package/4.api/2.composables/use-route.md +1 -1
- package/4.api/2.composables/use-router.md +2 -2
- package/4.api/2.composables/use-runtime-config.md +1 -1
- package/4.api/3.utils/$fetch.md +1 -1
- package/4.api/3.utils/abort-navigation.md +1 -1
- package/4.api/3.utils/add-route-middleware.md +1 -1
- package/4.api/3.utils/define-nuxt-plugin.md +2 -2
- package/4.api/3.utils/define-nuxt-route-middleware.md +1 -1
- package/4.api/3.utils/define-page-meta.md +6 -6
- package/4.api/3.utils/navigate-to.md +1 -1
- package/4.api/3.utils/update-app-config.md +2 -2
- package/4.api/4.commands/module.md +3 -3
- package/4.api/4.commands/prepare.md +1 -1
- package/4.api/4.commands/preview.md +1 -1
- package/4.api/4.commands/typecheck.md +1 -1
- package/4.api/5.kit/1.modules.md +1 -1
- package/4.api/5.kit/2.programmatic.md +2 -2
- package/4.api/6.advanced/1.hooks.md +1 -1
- package/4.api/6.nuxt-config.md +4 -4
- package/5.community/6.roadmap.md +10 -10
- package/5.community/7.changelog.md +10 -0
- package/6.bridge/1.overview.md +1 -1
- package/6.bridge/2.typescript.md +1 -1
- package/6.bridge/3.bridge-composition-api.md +1 -1
- package/6.bridge/4.plugins-and-middleware.md +2 -2
- package/7.migration/11.server.md +1 -1
- package/7.migration/2.configuration.md +2 -2
- package/7.migration/20.module-authors.md +1 -1
- package/7.migration/3.auto-imports.md +1 -1
- package/7.migration/5.plugins-and-middleware.md +2 -2
- package/7.migration/6.pages-and-layouts.md +6 -6
- package/package.json +1 -1
- /package/3.guide/{3.recipes → 4.recipes}/.navigation.yml +0 -0
- /package/3.guide/{4.going-further → 5.going-further}/.navigation.yml +0 -0
- /package/3.guide/{4.going-further → 5.going-further}/1.features.md +0 -0
- /package/3.guide/{4.going-further → 5.going-further}/11.nightly-release-channel.md +0 -0
- /package/3.guide/{4.going-further → 5.going-further}/4.kit.md +0 -0
- /package/3.guide/{4.going-further → 5.going-further}/9.debugging.md +0 -0
- /package/3.guide/{4.going-further → 5.going-further}/index.md +0 -0
|
@@ -140,7 +140,7 @@ If you are a module author, you can check out [more information about module com
|
|
|
140
140
|
|
|
141
141
|
The `static/` (for storing static assets) has been renamed to `public/`. You can either rename your `static` directory to `public`, or keep the name by setting `dir.public` in your `nuxt.config`.
|
|
142
142
|
|
|
143
|
-
:read-more{to="/docs/4.x/
|
|
143
|
+
:read-more{to="/docs/4.x/directory-structure/public"}
|
|
144
144
|
|
|
145
145
|
## TypeScript
|
|
146
146
|
|
|
@@ -227,7 +227,7 @@ export const useMainStore = defineStore('main', {
|
|
|
227
227
|
})
|
|
228
228
|
```
|
|
229
229
|
|
|
230
|
-
Create a [plugin](/docs/4.x/
|
|
230
|
+
Create a [plugin](/docs/4.x/directory-structure/app/plugins) file to globalize your store:
|
|
231
231
|
|
|
232
232
|
```ts [app/plugins/pinia.ts]
|
|
233
233
|
import { useMainStore } from '~/store'
|
|
@@ -17,7 +17,7 @@ Explore Nuxt 3 compatible modules.
|
|
|
17
17
|
|
|
18
18
|
Nuxt 3 plugins are **not** fully backward compatible with Nuxt 2.
|
|
19
19
|
|
|
20
|
-
:read-more{to="/docs/4.x/
|
|
20
|
+
:read-more{to="/docs/4.x/directory-structure/app/plugins"}
|
|
21
21
|
|
|
22
22
|
### Vue Compatibility
|
|
23
23
|
|
|
@@ -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/4.x/
|
|
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/4.x/directory-structure/app/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.
|
|
@@ -31,7 +31,7 @@ export default defineNuxtPlugin((nuxtApp) => {
|
|
|
31
31
|
|
|
32
32
|
::
|
|
33
33
|
|
|
34
|
-
:read-more{to="/docs/4.x/
|
|
34
|
+
:read-more{to="/docs/4.x/directory-structure/app/plugins"}
|
|
35
35
|
|
|
36
36
|
::read-more{to="/docs/4.x/api/composables/use-nuxt-app"}
|
|
37
37
|
Read more about the format of `nuxtApp`.
|
|
@@ -72,7 +72,7 @@ Much like Nuxt 2, route middleware placed in your `~/middleware` folder is autom
|
|
|
72
72
|
|
|
73
73
|
`navigateTo` is one of a number of route helper functions.
|
|
74
74
|
|
|
75
|
-
:read-more{to="/docs/4.x/
|
|
75
|
+
:read-more{to="/docs/4.x/directory-structure/app/middleware"}
|
|
76
76
|
|
|
77
77
|
### Migration
|
|
78
78
|
|
|
@@ -13,19 +13,19 @@ If you don't have an `app.vue` file in your source directory, Nuxt will use its
|
|
|
13
13
|
|
|
14
14
|
This file is a great place to put any custom code that needs to be run once when your app starts up, as well as any components that are present on every page of your app. For example, if you only have one layout, you can move this to `app.vue` instead.
|
|
15
15
|
|
|
16
|
-
:read-more{to="/docs/4.x/
|
|
16
|
+
:read-more{to="/docs/4.x/directory-structure/app/app"}
|
|
17
17
|
|
|
18
18
|
:link-example{to="/docs/4.x/examples/hello-world"}
|
|
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/4.x/
|
|
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/4.x/directory-structure/app/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/4.x/
|
|
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/4.x/directory-structure/app/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 `app/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/4.x/getting-started/error-handling). If you want to ensure that this page uses a layout, you can use [`<NuxtLayout>`](/docs/4.x/
|
|
57
|
+
3. Move `~/layouts/_error.vue` to `~/error.vue`. See [the error handling docs](/docs/4.x/getting-started/error-handling). If you want to ensure that this page uses a layout, you can use [`<NuxtLayout>`](/docs/4.x/directory-structure/app/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 [`app/pages/`](/docs/4.x/
|
|
70
|
+
Nuxt 3 ships with an optional `vue-router` integration triggered by the existence of a [`app/pages/`](/docs/4.x/directory-structure/app/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
|
|
|
@@ -84,7 +84,7 @@ In Nuxt 2, you will have defined any nested routes (with parent and child compon
|
|
|
84
84
|
|
|
85
85
|
If you were passing a custom page key or keep-alive props to `<Nuxt>`, you will now use `definePageMeta` to set these options.
|
|
86
86
|
|
|
87
|
-
:read-more{to="/docs/4.x/
|
|
87
|
+
:read-more{to="/docs/4.x/directory-structure/app/pages#special-metadata"}
|
|
88
88
|
|
|
89
89
|
### Page and Layout Transitions
|
|
90
90
|
|
package/package.json
CHANGED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|