mirror of
https://github.com/nuxt/nuxt.git
synced 2024-11-26 23:52:06 +00:00
chore: update internal repo/issue links to usenuxt/nuxt
This commit is contained in:
parent
371bc1affc
commit
081dc3254f
@ -10,8 +10,8 @@ Nuxt's goal is to make web development intuitive and performant, with a great de
|
|||||||
<p>
|
<p>
|
||||||
<a href="https://www.npmjs.com/package/nuxt"><img src="https://img.shields.io/npm/v/nuxt.svg?style=flat&colorA=18181B&colorB=28CF8D" alt="Version"></a>
|
<a href="https://www.npmjs.com/package/nuxt"><img src="https://img.shields.io/npm/v/nuxt.svg?style=flat&colorA=18181B&colorB=28CF8D" alt="Version"></a>
|
||||||
<a href="https://www.npmjs.com/package/nuxt"><img src="https://img.shields.io/npm/dm/nuxt.svg?style=flat&colorA=18181B&colorB=28CF8D" alt="Downloads"></a>
|
<a href="https://www.npmjs.com/package/nuxt"><img src="https://img.shields.io/npm/dm/nuxt.svg?style=flat&colorA=18181B&colorB=28CF8D" alt="Downloads"></a>
|
||||||
<a href="./LICENSE"><img src="https://img.shields.io/github/license/nuxt/framework.svg?style=flat&colorA=18181B&colorB=28CF8D" alt="License"></a>
|
<a href="./LICENSE"><img src="https://img.shields.io/github/license/nuxt/nuxt.svg?style=flat&colorA=18181B&colorB=28CF8D" alt="License"></a>
|
||||||
<a href="https://volta.net/nuxt/framework?utm_source=nuxt_readme"><img src="https://user-images.githubusercontent.com/904724/209143798-32345f6c-3cf8-4e06-9659-f4ace4a6acde.svg" alt="Volta board"></a>
|
<a href="https://volta.net/nuxt/nuxt?utm_source=nuxt_readme"><img src="https://user-images.githubusercontent.com/904724/209143798-32345f6c-3cf8-4e06-9659-f4ace4a6acde.svg" alt="Volta board"></a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<table>
|
<table>
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
## Reporting a Vulnerability
|
## Reporting a Vulnerability
|
||||||
|
|
||||||
To report a vulnerability, please send an email to **security@nuxtjs.org** or submit it for a bounty via [Huntr](https://huntr.dev/bounties/disclose/?target=https://github.com/nuxt/framework).
|
To report a vulnerability, please send an email to **security@nuxtjs.org** or submit it for a bounty via [Huntr](https://huntr.dev/bounties/disclose/?target=https://github.com/nuxt/nuxt).
|
||||||
|
|
||||||
All security vulnerabilities will be promptly verified and addressed.
|
All security vulnerabilities will be promptly verified and addressed.
|
||||||
|
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"github": "nuxt/framework",
|
"github": "nuxt/nuxt",
|
||||||
"scopeMap": {
|
"scopeMap": {
|
||||||
"nuxt3": "nuxt",
|
"nuxt3": "nuxt",
|
||||||
"nuxi": "cli"
|
"nuxi": "cli"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -12,7 +12,7 @@ topButtonLink: '/vision-2023'
|
|||||||
primaryButtonText: 'Get started'
|
primaryButtonText: 'Get started'
|
||||||
primaryButtonLink: '/docs/getting-started/introduction'
|
primaryButtonLink: '/docs/getting-started/introduction'
|
||||||
secondaryButtonText: 'Open on GitHub'
|
secondaryButtonText: 'Open on GitHub'
|
||||||
secondaryButtonLink: 'https://github.com/nuxt/framework'
|
secondaryButtonLink: 'https://github.com/nuxt/nuxt'
|
||||||
---
|
---
|
||||||
|
|
||||||
#title
|
#title
|
||||||
|
@ -165,14 +165,14 @@ Discover more about [modules](/docs/guide/concepts/modules).
|
|||||||
|
|
||||||
### Architecture
|
### Architecture
|
||||||
|
|
||||||
Nuxt is composed of different [core packages](https://github.com/nuxt/framework/tree/main/packages):
|
Nuxt is composed of different [core packages](https://github.com/nuxt/nuxt/tree/main/packages):
|
||||||
|
|
||||||
::list{type=info}
|
::list{type=info}
|
||||||
- Core Engine: [nuxt](https://github.com/nuxt/framework/tree/main/packages/nuxt)
|
- Core Engine: [nuxt](https://github.com/nuxt/nuxt/tree/main/packages/nuxt)
|
||||||
- Bundlers: [@nuxt/vite-builder](https://github.com/nuxt/framework/tree/main/packages/vite) and [@nuxt/webpack-builder](https://github.com/nuxt/framework/tree/main/packages/webpack)
|
- Bundlers: [@nuxt/vite-builder](https://github.com/nuxt/nuxt/tree/main/packages/vite) and [@nuxt/webpack-builder](https://github.com/nuxt/nuxt/tree/main/packages/webpack)
|
||||||
- Command line interface: [nuxi](https://github.com/nuxt/framework/tree/main/packages/nuxi)
|
- Command line interface: [nuxi](https://github.com/nuxt/nuxt/tree/main/packages/nuxi)
|
||||||
- Server engine: [nitro](https://github.com/unjs/nitro)
|
- Server engine: [nitro](https://github.com/unjs/nitro)
|
||||||
- Development kit: [@nuxt/kit](https://github.com/nuxt/framework/tree/main/packages/kit)
|
- Development kit: [@nuxt/kit](https://github.com/nuxt/nuxt/tree/main/packages/kit)
|
||||||
- Nuxt 2 Bridge: [@nuxt/bridge](https://github.com/nuxt/bridge)
|
- Nuxt 2 Bridge: [@nuxt/bridge](https://github.com/nuxt/bridge)
|
||||||
::
|
::
|
||||||
|
|
||||||
|
@ -19,7 +19,7 @@ Therefore only one instance of Nuxt is allowed to run per process.
|
|||||||
|
|
||||||
To extend the Nuxt interface and hook into different stages of the build process, we can use [Nuxt Modules](/docs/guide/going-further/modules).
|
To extend the Nuxt interface and hook into different stages of the build process, we can use [Nuxt Modules](/docs/guide/going-further/modules).
|
||||||
|
|
||||||
For more details, check out [the source code](https://github.com/nuxt/framework/blob/main/packages/nuxt/src/core/nuxt.ts).
|
For more details, check out [the source code](https://github.com/nuxt/nuxt/blob/main/packages/nuxt/src/core/nuxt.ts).
|
||||||
|
|
||||||
## The NuxtApp Interface
|
## The NuxtApp Interface
|
||||||
|
|
||||||
@ -43,7 +43,7 @@ const nuxtApp = {
|
|||||||
vueApp, // the global Vue application: https://vuejs.org/api/application.html#application-api
|
vueApp, // the global Vue application: https://vuejs.org/api/application.html#application-api
|
||||||
|
|
||||||
// These let you call and add runtime NuxtApp hooks
|
// These let you call and add runtime NuxtApp hooks
|
||||||
// https://github.com/nuxt/framework/blob/main/packages/nuxt/src/app/nuxt.ts#L18
|
// https://github.com/nuxt/nuxt/blob/main/packages/nuxt/src/app/nuxt.ts#L18
|
||||||
hooks,
|
hooks,
|
||||||
hook,
|
hook,
|
||||||
callHook,
|
callHook,
|
||||||
@ -68,7 +68,7 @@ const nuxtApp = {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
For more details, check out [the source code](https://github.com/nuxt/framework/blob/main/packages/nuxt/src/app/nuxt.ts).
|
For more details, check out [the source code](https://github.com/nuxt/nuxt/blob/main/packages/nuxt/src/app/nuxt.ts).
|
||||||
|
|
||||||
## Runtime Context vs. Build Context
|
## Runtime Context vs. Build Context
|
||||||
|
|
||||||
|
@ -7,7 +7,7 @@ description: "Edge channel allows to use latest commits from the repository."
|
|||||||
|
|
||||||
Nuxt 3 is landing commits, improvements, and bug fixes every day. You can opt-in to test them earlier before the next release.
|
Nuxt 3 is landing commits, improvements, and bug fixes every day. You can opt-in to test them earlier before the next release.
|
||||||
|
|
||||||
After each commit is merged into the `main` branch of [nuxt/framework](https://github.com/nuxt/framework) and **passing all tests**, we trigger an automated npm release using GitHub Actions publishing Nuxt 3 packages.
|
After each commit is merged into the `main` branch of [nuxt/nuxt](https://github.com/nuxt/nuxt) and **passing all tests**, we trigger an automated npm release using GitHub Actions publishing Nuxt 3 packages.
|
||||||
|
|
||||||
You can opt in to use this release channel and avoid waiting for the next release and helping Nuxt by beta testing changes.
|
You can opt in to use this release channel and avoid waiting for the next release and helping Nuxt by beta testing changes.
|
||||||
|
|
||||||
|
@ -225,7 +225,7 @@ describe('ssr', async () => {
|
|||||||
})
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
For more usage, please refer to our [tests for Nuxt 3 framework](https://github.com/nuxt/framework/blob/main/test/basic.test.ts).
|
For more usage, please refer to our [tests for Nuxt 3 framework](https://github.com/nuxt/nuxt/blob/main/test/basic.test.ts).
|
||||||
|
|
||||||
### Mock utils
|
### Mock utils
|
||||||
|
|
||||||
|
@ -196,4 +196,4 @@ export default defineNuxtModule({
|
|||||||
|
|
||||||
Configuration loading and extends support is handled by [unjs/c12](https://github.com/unjs/c12), merged using [unjs/defu](https://github.com/unjs/defu) and remote git sources are supported using [unjs/giget](https://github.com/unjs/giget). Check the docs and source code to learn more.
|
Configuration loading and extends support is handled by [unjs/c12](https://github.com/unjs/c12), merged using [unjs/defu](https://github.com/unjs/defu) and remote git sources are supported using [unjs/giget](https://github.com/unjs/giget). Check the docs and source code to learn more.
|
||||||
|
|
||||||
We are working to bring more improvements for layers support. Please refer to [nuxt/framework#3222](https://github.com/nuxt/framework/issues/3222).
|
We are working to bring more improvements for layers support. Please refer to [nuxt/nuxt#13367](https://github.com/nuxt/nuxt/issues/13367).
|
||||||
|
@ -38,7 +38,7 @@ counter.value = counter.value || Math.round(Math.random() * 1000)
|
|||||||
</script>
|
</script>
|
||||||
```
|
```
|
||||||
|
|
||||||
:button-link[Open on StackBlitz]{href="https://stackblitz.com/github/nuxt/framework/tree/main/examples/composables/use-cookie?terminal=dev&file=app.vue" blank}
|
:button-link[Open on StackBlitz]{href="https://stackblitz.com/github/nuxt/nuxt/tree/main/examples/composables/use-cookie?terminal=dev&file=app.vue" blank}
|
||||||
|
|
||||||
## Options
|
## Options
|
||||||
|
|
||||||
|
@ -44,7 +44,7 @@ definePageMeta({
|
|||||||
</script>
|
</script>
|
||||||
```
|
```
|
||||||
|
|
||||||
:button-link[Open on StackBlitz]{href="https://stackblitz.com/github/nuxt/framework/tree/main/examples/routing/pages?file=app.vue" blank}
|
:button-link[Open on StackBlitz]{href="https://stackblitz.com/github/nuxt/nuxt/tree/main/examples/routing/pages?file=app.vue" blank}
|
||||||
|
|
||||||
## Custom Props
|
## Custom Props
|
||||||
|
|
||||||
|
@ -24,7 +24,7 @@ In this example, we use `<NuxtLink>` component to link to a website.
|
|||||||
</template>
|
</template>
|
||||||
```
|
```
|
||||||
|
|
||||||
:button-link[Open on StackBlitz]{href="https://stackblitz.com/github/nuxt/framework/tree/main/examples/routing/nuxt-link?terminal=dev&file=/pages/index.vue" blank}
|
:button-link[Open on StackBlitz]{href="https://stackblitz.com/github/nuxt/nuxt/tree/main/examples/routing/nuxt-link?terminal=dev&file=/pages/index.vue" blank}
|
||||||
|
|
||||||
### Internal Routing
|
### Internal Routing
|
||||||
|
|
||||||
@ -39,7 +39,7 @@ In this example, we use `<NuxtLink>` component to link to another page of the ap
|
|||||||
</template>
|
</template>
|
||||||
```
|
```
|
||||||
|
|
||||||
:button-link[Open on StackBlitz]{href="https://stackblitz.com/github/nuxt/framework/tree/main/examples/routing/nuxt-link?terminal=dev&file=/pages/index.vue" blank}
|
:button-link[Open on StackBlitz]{href="https://stackblitz.com/github/nuxt/nuxt/tree/main/examples/routing/nuxt-link?terminal=dev&file=/pages/index.vue" blank}
|
||||||
|
|
||||||
### `target` and `rel` Attributes
|
### `target` and `rel` Attributes
|
||||||
|
|
||||||
@ -69,7 +69,7 @@ In this example, we use `<NuxtLink>` with `target`, `rel`, and `noRel` props.
|
|||||||
</template>
|
</template>
|
||||||
```
|
```
|
||||||
|
|
||||||
:button-link[Open on StackBlitz]{href="https://stackblitz.com/github/nuxt/framework/tree/main/examples/routing/nuxt-link?terminal=dev&file=/pages/index.vue" blank}
|
:button-link[Open on StackBlitz]{href="https://stackblitz.com/github/nuxt/nuxt/tree/main/examples/routing/nuxt-link?terminal=dev&file=/pages/index.vue" blank}
|
||||||
|
|
||||||
## Props
|
## Props
|
||||||
|
|
||||||
@ -104,7 +104,7 @@ export default defineNuxtLink({
|
|||||||
|
|
||||||
You can then use `<MyNuxtLink />` component as usual with your new defaults.
|
You can then use `<MyNuxtLink />` component as usual with your new defaults.
|
||||||
|
|
||||||
:button-link[Open on StackBlitz]{href="https://stackblitz.com/github/nuxt/framework/tree/main/examples/routing/nuxt-link?terminal=dev&file=/components/MyNuxtLink.ts" blank}
|
:button-link[Open on StackBlitz]{href="https://stackblitz.com/github/nuxt/nuxt/tree/main/examples/routing/nuxt-link?terminal=dev&file=/components/MyNuxtLink.ts" blank}
|
||||||
|
|
||||||
### `defineNuxtLink` Signature
|
### `defineNuxtLink` Signature
|
||||||
|
|
||||||
|
@ -17,7 +17,7 @@ Add `<NuxtLoadingIndicator/>` in your `app.vue` or layouts.
|
|||||||
</template>
|
</template>
|
||||||
```
|
```
|
||||||
|
|
||||||
:button-link[Open on StackBlitz]{href="https://stackblitz.com/github/nuxt/framework/tree/main/examples/routing/pages?terminal=dev&file=/app.vue" blank}
|
:button-link[Open on StackBlitz]{href="https://stackblitz.com/github/nuxt/nuxt/tree/main/examples/routing/pages?terminal=dev&file=/app.vue" blank}
|
||||||
|
|
||||||
::alert{type=warning}
|
::alert{type=warning}
|
||||||
If you are changing layouts as well as page, the page transition you set here will not run. Instead, you should set a layout transition.
|
If you are changing layouts as well as page, the page transition you set here will not run. Instead, you should set a layout transition.
|
||||||
@ -35,5 +35,5 @@ You can pass custom HTML or components through the loading indicator's default s
|
|||||||
- **throttle**: Throttle the appearing and hiding, in milliseconds (default `200`).
|
- **throttle**: Throttle the appearing and hiding, in milliseconds (default `200`).
|
||||||
|
|
||||||
::alert{type=info icon=🔎}
|
::alert{type=info icon=🔎}
|
||||||
This component is completely optional. To achieve full customization, you can implement your own one based on [this file](https://github.com/nuxt/framework/blob/main/packages/nuxt/src/app/components/nuxt-loading-indicator.ts).
|
This component is completely optional. To achieve full customization, you can implement your own one based on [this file](https://github.com/nuxt/nuxt/blob/main/packages/nuxt/src/app/components/nuxt-loading-indicator.ts).
|
||||||
::
|
::
|
||||||
|
@ -9,7 +9,7 @@ description: Nuxt provides a powerful hooking system to expand almost every aspe
|
|||||||
|
|
||||||
# App Hooks (runtime)
|
# App Hooks (runtime)
|
||||||
|
|
||||||
Check the [app source code](https://github.com/nuxt/framework/blob/main/packages/nuxt/src/app/nuxt.ts#L27) for all available hooks.
|
Check the [app source code](https://github.com/nuxt/nuxt/blob/main/packages/nuxt/src/app/nuxt.ts#L27) for all available hooks.
|
||||||
|
|
||||||
Hook | Arguments | Environment | Description
|
Hook | Arguments | Environment | Description
|
||||||
-----------------------|---------------------|-----------------|-------------
|
-----------------------|---------------------|-----------------|-------------
|
||||||
@ -31,7 +31,7 @@ Hook | Arguments | Environment | Description
|
|||||||
|
|
||||||
# Nuxt Hooks (build time)
|
# Nuxt Hooks (build time)
|
||||||
|
|
||||||
Check the [schema source code](https://github.com/nuxt/framework/blob/main/packages/schema/src/types/hooks.ts#L53) for all available hooks.
|
Check the [schema source code](https://github.com/nuxt/nuxt/blob/main/packages/schema/src/types/hooks.ts#L53) for all available hooks.
|
||||||
|
|
||||||
:NeedContribution
|
:NeedContribution
|
||||||
|
|
||||||
@ -39,5 +39,5 @@ Check the [schema source code](https://github.com/nuxt/framework/blob/main/packa
|
|||||||
|
|
||||||
Hook | Arguments | Description | Types
|
Hook | Arguments | Description | Types
|
||||||
-----------------------|-----------------------|--------------------------------------|------------------
|
-----------------------|-----------------------|--------------------------------------|------------------
|
||||||
`render:response` | `response, { event }` | Called before sending the response. | [response](https://github.com/nuxt/framework/blob/71ef8bd3ff207fd51c2ca18d5a8c7140476780c7/packages/nuxt/src/core/runtime/nitro/renderer.ts#L24), [event](https://github.com/unjs/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38)
|
`render:response` | `response, { event }` | Called before sending the response. | [response](https://github.com/nuxt/nuxt/blob/71ef8bd3ff207fd51c2ca18d5a8c7140476780c7/packages/nuxt/src/core/runtime/nitro/renderer.ts#L24), [event](https://github.com/unjs/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38)
|
||||||
`render:html` | `html, { event }` | Called before constructing the HTML. | [html](https://github.com/nuxt/framework/blob/71ef8bd3ff207fd51c2ca18d5a8c7140476780c7/packages/nuxt/src/core/runtime/nitro/renderer.ts#L15), [event](https://github.com/unjs/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38)
|
`render:html` | `html, { event }` | Called before constructing the HTML. | [html](https://github.com/nuxt/nuxt/blob/71ef8bd3ff207fd51c2ca18d5a8c7140476780c7/packages/nuxt/src/core/runtime/nitro/renderer.ts#L15), [event](https://github.com/unjs/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38)
|
||||||
|
@ -12,13 +12,13 @@ description: Nuxt Kit provides composable utilities to help interacting with Nux
|
|||||||
|
|
||||||
### Modules
|
### Modules
|
||||||
|
|
||||||
[source code](https://github.com/nuxt/framework/blob/main/packages/kit/src/module)
|
[source code](https://github.com/nuxt/nuxt/blob/main/packages/kit/src/module)
|
||||||
|
|
||||||
- `installModule(module, inlineOptions)`
|
- `installModule(module, inlineOptions)`
|
||||||
|
|
||||||
### Programmatic Usage
|
### Programmatic Usage
|
||||||
|
|
||||||
[source code](https://github.com/nuxt/framework/blob/main/packages/kit/src/loader)
|
[source code](https://github.com/nuxt/nuxt/blob/main/packages/kit/src/loader)
|
||||||
|
|
||||||
- `loadNuxt(loadOptions)`
|
- `loadNuxt(loadOptions)`
|
||||||
- `buildNuxt(nuxt)`
|
- `buildNuxt(nuxt)`
|
||||||
@ -26,7 +26,7 @@ description: Nuxt Kit provides composable utilities to help interacting with Nux
|
|||||||
|
|
||||||
### Compatibility
|
### Compatibility
|
||||||
|
|
||||||
[source code](https://github.com/nuxt/framework/blob/main/packages/kit/src/compatibility.ts)
|
[source code](https://github.com/nuxt/nuxt/blob/main/packages/kit/src/compatibility.ts)
|
||||||
|
|
||||||
- `checkNuxtCompatibility(constraints)`
|
- `checkNuxtCompatibility(constraints)`
|
||||||
- `assertNuxtCompatibility(constraints)`
|
- `assertNuxtCompatibility(constraints)`
|
||||||
@ -37,7 +37,7 @@ description: Nuxt Kit provides composable utilities to help interacting with Nux
|
|||||||
|
|
||||||
### Auto-imports
|
### Auto-imports
|
||||||
|
|
||||||
[source code](https://github.com/nuxt/framework/blob/main/packages/kit/src/imports.ts)
|
[source code](https://github.com/nuxt/nuxt/blob/main/packages/kit/src/imports.ts)
|
||||||
|
|
||||||
- `addImports(imports)`
|
- `addImports(imports)`
|
||||||
- `addImportsDir(importDirs)`
|
- `addImportsDir(importDirs)`
|
||||||
@ -45,40 +45,40 @@ description: Nuxt Kit provides composable utilities to help interacting with Nux
|
|||||||
|
|
||||||
### Components
|
### Components
|
||||||
|
|
||||||
[source code](https://github.com/nuxt/framework/blob/main/packages/kit/src/components.ts)
|
[source code](https://github.com/nuxt/nuxt/blob/main/packages/kit/src/components.ts)
|
||||||
|
|
||||||
- `addComponentsDir(dir)`
|
- `addComponentsDir(dir)`
|
||||||
- `addComponent(componentObject)`
|
- `addComponent(componentObject)`
|
||||||
|
|
||||||
### Context
|
### Context
|
||||||
|
|
||||||
[source code](https://github.com/nuxt/framework/blob/main/packages/kit/src/context.ts)
|
[source code](https://github.com/nuxt/nuxt/blob/main/packages/kit/src/context.ts)
|
||||||
|
|
||||||
- `useNuxt()`
|
- `useNuxt()`
|
||||||
|
|
||||||
### Pages
|
### Pages
|
||||||
|
|
||||||
[source code](https://github.com/nuxt/framework/blob/main/packages/kit/src/pages.ts)
|
[source code](https://github.com/nuxt/nuxt/blob/main/packages/kit/src/pages.ts)
|
||||||
|
|
||||||
- `extendPages (callback: pages => void)`
|
- `extendPages (callback: pages => void)`
|
||||||
|
|
||||||
### Plugins
|
### Plugins
|
||||||
|
|
||||||
[source code](https://github.com/nuxt/framework/blob/main/packages/kit/src/plugin.ts)
|
[source code](https://github.com/nuxt/nuxt/blob/main/packages/kit/src/plugin.ts)
|
||||||
|
|
||||||
- `addPlugin(pluginOptions, { append? })`
|
- `addPlugin(pluginOptions, { append? })`
|
||||||
- `addPluginTemplate(pluginOptions, { append? })`
|
- `addPluginTemplate(pluginOptions, { append? })`
|
||||||
|
|
||||||
### Templates
|
### Templates
|
||||||
|
|
||||||
[source code](https://github.com/nuxt/framework/blob/main/packages/kit/src/template.ts)
|
[source code](https://github.com/nuxt/nuxt/blob/main/packages/kit/src/template.ts)
|
||||||
|
|
||||||
- `addTemplate(templateOptions)`
|
- `addTemplate(templateOptions)`
|
||||||
- `updateTemplates({ filter?: ResolvedNuxtTemplate => boolean })`
|
- `updateTemplates({ filter?: ResolvedNuxtTemplate => boolean })`
|
||||||
|
|
||||||
### Nitro
|
### Nitro
|
||||||
|
|
||||||
[source code](https://github.com/nuxt/framework/blob/main/packages/kit/src/nitro.ts)
|
[source code](https://github.com/nuxt/nuxt/blob/main/packages/kit/src/nitro.ts)
|
||||||
|
|
||||||
- `addServerHandler (handler)`
|
- `addServerHandler (handler)`
|
||||||
- `addDevServerHandler (handler)`
|
- `addDevServerHandler (handler)`
|
||||||
@ -88,7 +88,7 @@ description: Nuxt Kit provides composable utilities to help interacting with Nux
|
|||||||
|
|
||||||
### Resolving
|
### Resolving
|
||||||
|
|
||||||
[source code](https://github.com/nuxt/framework/blob/main/packages/kit/src/resolve.ts)
|
[source code](https://github.com/nuxt/nuxt/blob/main/packages/kit/src/resolve.ts)
|
||||||
|
|
||||||
- `resolvePath (path, resolveOptions?)`
|
- `resolvePath (path, resolveOptions?)`
|
||||||
- `resolveAlias (path, aliases?)`
|
- `resolveAlias (path, aliases?)`
|
||||||
@ -97,13 +97,13 @@ description: Nuxt Kit provides composable utilities to help interacting with Nux
|
|||||||
|
|
||||||
### Logging
|
### Logging
|
||||||
|
|
||||||
[source code](https://github.com/nuxt/framework/blob/main/packages/kit/src/logger.ts)
|
[source code](https://github.com/nuxt/nuxt/blob/main/packages/kit/src/logger.ts)
|
||||||
|
|
||||||
- `useLogger(scope?)`
|
- `useLogger(scope?)`
|
||||||
|
|
||||||
### Builder
|
### Builder
|
||||||
|
|
||||||
[source code](https://github.com/nuxt/framework/blob/main/packages/kit/src/build.ts)
|
[source code](https://github.com/nuxt/nuxt/blob/main/packages/kit/src/build.ts)
|
||||||
|
|
||||||
- `extendWebpackConfig(callback, options?)`
|
- `extendWebpackConfig(callback, options?)`
|
||||||
- `extendViteConfig(callback, options?)`
|
- `extendViteConfig(callback, options?)`
|
||||||
|
@ -9,5 +9,5 @@ A minimal Nuxt 3 application only requires the `app.vue` and `nuxt.config.js` fi
|
|||||||
::ReadMore{link="/docs/getting-started/introduction"}
|
::ReadMore{link="/docs/getting-started/introduction"}
|
||||||
::
|
::
|
||||||
|
|
||||||
::sandbox{repo="nuxt/framework" branch="main" dir="examples/essentials/hello-world" file="app.vue"}
|
::sandbox{repo="nuxt/nuxt" branch="main" dir="examples/essentials/hello-world" file="app.vue"}
|
||||||
::
|
::
|
||||||
|
@ -11,4 +11,4 @@ This example shows how to use `app.config` feature.
|
|||||||
::ReadMore{link="/docs/guide/features/app-config"}
|
::ReadMore{link="/docs/guide/features/app-config"}
|
||||||
::
|
::
|
||||||
|
|
||||||
::sandbox{repo="nuxt/framework" branch="main" dir="examples/app-config" file="app.vue"}
|
::sandbox{repo="nuxt/nuxt" branch="main" dir="examples/app-config" file="app.vue"}
|
||||||
|
@ -9,5 +9,5 @@ This example shows how to handle errors in different contexts: pages, plugins, c
|
|||||||
::ReadMore{link="/docs/getting-started/error-handling"}
|
::ReadMore{link="/docs/getting-started/error-handling"}
|
||||||
::
|
::
|
||||||
|
|
||||||
::sandbox{repo="nuxt/framework" branch="main" dir="examples/app/error-handling" file="app.vue"}
|
::sandbox{repo="nuxt/nuxt" branch="main" dir="examples/app/error-handling" file="app.vue"}
|
||||||
::
|
::
|
||||||
|
@ -9,5 +9,5 @@ This example shows how to use the plugins/ directory to auto-register plugins.
|
|||||||
:ReadMore{link="/docs/guide/directory-structure/plugins"}
|
:ReadMore{link="/docs/guide/directory-structure/plugins"}
|
||||||
::
|
::
|
||||||
|
|
||||||
::sandbox{repo="nuxt/framework" branch="main" dir="examples/app/plugins" file="app.vue"}
|
::sandbox{repo="nuxt/nuxt" branch="main" dir="examples/app/plugins" file="app.vue"}
|
||||||
::
|
::
|
||||||
|
@ -13,5 +13,5 @@ This example shows how to use the `<Teleport>` with client-side and server-side
|
|||||||
::ReadMore{link="/docs/api/components/teleports"}
|
::ReadMore{link="/docs/api/components/teleports"}
|
||||||
::
|
::
|
||||||
|
|
||||||
::sandbox{repo="nuxt/framework" branch="main" dir="examples/app/teleport" file="app.vue"}
|
::sandbox{repo="nuxt/nuxt" branch="main" dir="examples/app/teleport" file="app.vue"}
|
||||||
::
|
::
|
||||||
|
@ -9,5 +9,5 @@ Components in the `components/` directory are auto-imported and can be used dire
|
|||||||
::ReadMore{link="/docs/guide/directory-structure/components"}
|
::ReadMore{link="/docs/guide/directory-structure/components"}
|
||||||
::
|
::
|
||||||
|
|
||||||
::sandbox{repo="nuxt/framework" branch="main" dir="examples/auto-imports/components" file="app.vue"}
|
::sandbox{repo="nuxt/nuxt" branch="main" dir="examples/auto-imports/components" file="app.vue"}
|
||||||
::
|
::
|
||||||
|
@ -11,5 +11,5 @@ If the composable file provides a default export, the name of the composable wil
|
|||||||
::ReadMore{link="/docs/guide/directory-structure/composables"}
|
::ReadMore{link="/docs/guide/directory-structure/composables"}
|
||||||
::
|
::
|
||||||
|
|
||||||
::sandbox{repo="nuxt/framework" branch="main" dir="examples/auto-imports/composables" file="app.vue"}
|
::sandbox{repo="nuxt/nuxt" branch="main" dir="examples/auto-imports/composables" file="app.vue"}
|
||||||
::
|
::
|
||||||
|
@ -16,5 +16,5 @@ Nuxt will automatically read files in the `~/server/api` directory to create API
|
|||||||
::ReadMore{link="/docs/getting-started/data-fetching"}
|
::ReadMore{link="/docs/getting-started/data-fetching"}
|
||||||
::
|
::
|
||||||
|
|
||||||
::sandbox{repo="nuxt/framework" branch="main" dir="examples/composables/use-async-data" file="app.vue"}
|
::sandbox{repo="nuxt/nuxt" branch="main" dir="examples/composables/use-async-data" file="app.vue"}
|
||||||
::
|
::
|
||||||
|
@ -9,5 +9,5 @@ This example shows how to use the useCookie API to persist small amounts of data
|
|||||||
::ReadMore{link="/docs/api/composables/use-cookie"}
|
::ReadMore{link="/docs/api/composables/use-cookie"}
|
||||||
::
|
::
|
||||||
|
|
||||||
::sandbox{repo="nuxt/framework" branch="main" dir="examples/composables/use-cookie" file="app.vue"}
|
::sandbox{repo="nuxt/nuxt" branch="main" dir="examples/composables/use-cookie" file="app.vue"}
|
||||||
::
|
::
|
||||||
|
@ -16,5 +16,5 @@ Nuxt will automatically read files in the `~/server/api` directory to create API
|
|||||||
::ReadMore{link="/docs/getting-started/data-fetching"}
|
::ReadMore{link="/docs/getting-started/data-fetching"}
|
||||||
::
|
::
|
||||||
|
|
||||||
::sandbox{repo="nuxt/framework" branch="main" dir="examples/composables/use-fetch" file="app.vue"}
|
::sandbox{repo="nuxt/nuxt" branch="main" dir="examples/composables/use-fetch" file="app.vue"}
|
||||||
::
|
::
|
||||||
|
@ -12,5 +12,5 @@ This example shows how to use useHead and Nuxt built-in components to bind meta
|
|||||||
::ReadMore{link="/docs/getting-started/seo-meta"}
|
::ReadMore{link="/docs/getting-started/seo-meta"}
|
||||||
::
|
::
|
||||||
|
|
||||||
::sandbox{repo="nuxt/framework" branch="main" dir="examples/composables/use-head" file="app.vue"}
|
::sandbox{repo="nuxt/nuxt" branch="main" dir="examples/composables/use-head" file="app.vue"}
|
||||||
::
|
::
|
||||||
|
@ -18,5 +18,5 @@ Learn more about [useState](/docs/api/composables/use-state).
|
|||||||
::ReadMore{link="/docs/getting-started/state-management"}
|
::ReadMore{link="/docs/getting-started/state-management"}
|
||||||
::
|
::
|
||||||
|
|
||||||
::sandbox{repo="nuxt/framework" branch="main" dir="examples/composables/use-state" file="app.vue"}
|
::sandbox{repo="nuxt/nuxt" branch="main" dir="examples/composables/use-state" file="app.vue"}
|
||||||
::
|
::
|
||||||
|
@ -9,5 +9,5 @@ This example shows how to define default and custom layouts.
|
|||||||
::ReadMore{link="/docs/guide/directory-structure/layouts"}
|
::ReadMore{link="/docs/guide/directory-structure/layouts"}
|
||||||
::
|
::
|
||||||
|
|
||||||
::sandbox{repo="nuxt/framework" branch="main" dir="examples/routing/layouts" file="pages/index.vue"}
|
::sandbox{repo="nuxt/nuxt" branch="main" dir="examples/routing/layouts" file="pages/index.vue"}
|
||||||
::
|
::
|
||||||
|
@ -9,5 +9,5 @@ This example shows how to add route middleware with the middleware/ directory or
|
|||||||
::ReadMore{link="/docs/guide/directory-structure/middleware"}
|
::ReadMore{link="/docs/guide/directory-structure/middleware"}
|
||||||
::
|
::
|
||||||
|
|
||||||
::sandbox{repo="nuxt/framework" branch="main" dir="examples/routing/middleware" file="app.vue"}
|
::sandbox{repo="nuxt/nuxt" branch="main" dir="examples/routing/middleware" file="app.vue"}
|
||||||
::
|
::
|
||||||
|
@ -13,5 +13,5 @@ This example shows different ways to navigate between page with the `<NuxtLink>`
|
|||||||
::ReadMore{link="/docs/api/components/nuxt-link"}
|
::ReadMore{link="/docs/api/components/nuxt-link"}
|
||||||
::
|
::
|
||||||
|
|
||||||
::sandbox{repo="nuxt/framework" branch="main" dir="examples/routing/nuxt-link" file="app.vue"}
|
::sandbox{repo="nuxt/nuxt" branch="main" dir="examples/routing/nuxt-link" file="app.vue"}
|
||||||
::
|
::
|
||||||
|
@ -9,5 +9,5 @@ This example shows how to use the pages/ directory to create application routes.
|
|||||||
::ReadMore{link="/docs/guide/directory-structure/pages"}
|
::ReadMore{link="/docs/guide/directory-structure/pages"}
|
||||||
::
|
::
|
||||||
|
|
||||||
::sandbox{repo="nuxt/framework" branch="main" dir="examples/routing/pages" file="app.vue"}
|
::sandbox{repo="nuxt/nuxt" branch="main" dir="examples/routing/pages" file="app.vue"}
|
||||||
::
|
::
|
||||||
|
@ -6,5 +6,5 @@ toc: false
|
|||||||
|
|
||||||
This example demonstrates Nuxt universal routing utilities without depending on `pages/` and `vue-router`.
|
This example demonstrates Nuxt universal routing utilities without depending on `pages/` and `vue-router`.
|
||||||
|
|
||||||
::sandbox{repo="nuxt/framework" branch="main" dir="examples/routing/universal-router" file="app.vue"}
|
::sandbox{repo="nuxt/nuxt" branch="main" dir="examples/routing/universal-router" file="app.vue"}
|
||||||
::
|
::
|
||||||
|
@ -9,5 +9,5 @@ This example shows how to create server routes inside the `server/api` directory
|
|||||||
::ReadMore{link="/docs/guide/directory-structure/server"}
|
::ReadMore{link="/docs/guide/directory-structure/server"}
|
||||||
::
|
::
|
||||||
|
|
||||||
::sandbox{repo="nuxt/framework" branch="main" dir="examples/server/routes" file="app.vue"}
|
::sandbox{repo="nuxt/nuxt" branch="main" dir="examples/server/routes" file="app.vue"}
|
||||||
::
|
::
|
||||||
|
@ -8,5 +8,5 @@ This example shows how to use the extends key in `nuxt.config.ts`.
|
|||||||
|
|
||||||
This example shows how to use the `extends` key in nuxt.config.ts to use the `base/` directory as a base Nuxt application, and use its components, composables or config and override them if necessary.
|
This example shows how to use the `extends` key in nuxt.config.ts to use the `base/` directory as a base Nuxt application, and use its components, composables or config and override them if necessary.
|
||||||
|
|
||||||
::sandbox{repo="nuxt/framework" branch="main" dir="examples/advanced/config-extends" file="nuxt.config.ts"}
|
::sandbox{repo="nuxt/nuxt" branch="main" dir="examples/advanced/config-extends" file="nuxt.config.ts"}
|
||||||
::
|
::
|
||||||
|
@ -9,4 +9,4 @@ This example shows how to use [jsx syntax](https://vuejs.org/guide/extras/render
|
|||||||
::ReadMore{link="https://vuejs.org/guide/extras/render-function.html#jsx-tsx"}
|
::ReadMore{link="https://vuejs.org/guide/extras/render-function.html#jsx-tsx"}
|
||||||
::
|
::
|
||||||
|
|
||||||
::sandbox{repo="nuxt/framework" branch="main" dir="examples/advanced/jsx" file="nuxt.config.ts"}
|
::sandbox{repo="nuxt/nuxt" branch="main" dir="examples/advanced/jsx" file="nuxt.config.ts"}
|
||||||
|
@ -9,5 +9,5 @@ This example defines a new `test` page using `extendPages` within a module.
|
|||||||
::ReadMore{link="/docs/guide/going-further/modules"}
|
::ReadMore{link="/docs/guide/going-further/modules"}
|
||||||
::
|
::
|
||||||
|
|
||||||
::sandbox{repo="nuxt/framework" branch="main" dir="examples/advanced/module-extend-pages" file="pages/index.vue"}
|
::sandbox{repo="nuxt/nuxt" branch="main" dir="examples/advanced/module-extend-pages" file="pages/index.vue"}
|
||||||
::
|
::
|
||||||
|
@ -13,5 +13,5 @@ Learn more about [testing](/docs/guide/going-further/testing).
|
|||||||
::ReadMore{link="/docs/guide/going-further/testing"}
|
::ReadMore{link="/docs/guide/going-further/testing"}
|
||||||
::
|
::
|
||||||
|
|
||||||
::sandbox{repo="nuxt/framework" branch="main" dir="examples/advanced/testing" file="app.vue"}
|
::sandbox{repo="nuxt/nuxt" branch="main" dir="examples/advanced/testing" file="app.vue"}
|
||||||
::
|
::
|
||||||
|
@ -9,5 +9,5 @@ This example demonstrates the support of Reactivity Transform in Nuxt 3.
|
|||||||
::ReadMore{link="https://vuejs.org/guide/extras/reactivity-transform.html" title="Reactivity Transform"}
|
::ReadMore{link="https://vuejs.org/guide/extras/reactivity-transform.html" title="Reactivity Transform"}
|
||||||
::
|
::
|
||||||
|
|
||||||
::sandbox{repo="nuxt/framework" branch="main" dir="examples/experimental/reactivity-transform" file="app.vue"}
|
::sandbox{repo="nuxt/nuxt" branch="main" dir="examples/experimental/reactivity-transform" file="app.vue"}
|
||||||
::
|
::
|
||||||
|
@ -6,5 +6,5 @@ toc: false
|
|||||||
|
|
||||||
This example demonstrates the server-side support of WebAssembly in Nuxt 3.
|
This example demonstrates the server-side support of WebAssembly in Nuxt 3.
|
||||||
|
|
||||||
::sandbox{repo="nuxt/framework" branch="main" dir="examples/experimental/wasm" file="app.vue"}
|
::sandbox{repo="nuxt/nuxt" branch="main" dir="examples/experimental/wasm" file="app.vue"}
|
||||||
::
|
::
|
||||||
|
@ -10,4 +10,4 @@ This example shows how to define a locale composable to handle the application's
|
|||||||
You can right-click to "View Page Source" and see that Nuxt renders the correct date in SSR based on the visitor's locale.
|
You can right-click to "View Page Source" and see that Nuxt renders the correct date in SSR based on the visitor's locale.
|
||||||
::
|
::
|
||||||
|
|
||||||
::sandbox{repo="nuxt/framework" branch="main" dir="examples/other/locale" file="app.vue"}
|
::sandbox{repo="nuxt/nuxt" branch="main" dir="examples/other/locale" file="app.vue"}
|
||||||
|
@ -12,7 +12,7 @@ But don't worry! We're a friendly community of developers and we'd love to help.
|
|||||||
|
|
||||||
## "I can't figure out how to (...)."
|
## "I can't figure out how to (...)."
|
||||||
|
|
||||||
You've read through these docs and you think it should be possible, but it's not clear how. The best thing is to [open a GitHub Discussion](https://github.com/nuxt/framework/discussions).
|
You've read through these docs and you think it should be possible, but it's not clear how. The best thing is to [open a GitHub Discussion](https://github.com/nuxt/nuxt/discussions).
|
||||||
|
|
||||||
Please don't feel embarrassed about asking a question that you think is easy - we've all been there! ❤️
|
Please don't feel embarrassed about asking a question that you think is easy - we've all been there! ❤️
|
||||||
|
|
||||||
@ -30,6 +30,6 @@ And finally, just ask the question! There's no need to [ask permission to ask a
|
|||||||
|
|
||||||
## "Could there be a bug?"
|
## "Could there be a bug?"
|
||||||
|
|
||||||
Something isn't working the way that the docs say that it should. You're not sure if it's a bug. You've searched through the [open issues](https://github.com/nuxt/framework/issues) and [discussions](https://github.com/nuxt/framework/discussions) but you can't find anything. (if there is a closed issue, please create a new one)
|
Something isn't working the way that the docs say that it should. You're not sure if it's a bug. You've searched through the [open issues](https://github.com/nuxt/nuxt/issues) and [discussions](https://github.com/nuxt/nuxt/discussions) but you can't find anything. (if there is a closed issue, please create a new one)
|
||||||
|
|
||||||
We recommend taking a look at [how to report bugs](/docs/community/reporting-bugs). Nuxt 3 is still in active development, and every issue helps make it better.
|
We recommend taking a look at [how to report bugs](/docs/community/reporting-bugs). Nuxt 3 is still in active development, and every issue helps make it better.
|
||||||
|
@ -18,7 +18,7 @@ Consider if you're looking to get help with something, or whether you think ther
|
|||||||
|
|
||||||
## Search the Issues
|
## Search the Issues
|
||||||
|
|
||||||
Search through the [open issues](https://github.com/nuxt/framework/issues) and [discussions](https://github.com/nuxt/framework/discussions) first. If you find anything that seems like the same bug, it's much better to comment on an existing thread than create a duplicate.
|
Search through the [open issues](https://github.com/nuxt/nuxt/issues) and [discussions](https://github.com/nuxt/nuxt/discussions) first. If you find anything that seems like the same bug, it's much better to comment on an existing thread than create a duplicate.
|
||||||
|
|
||||||
## Create a Minimal Reproduction
|
## Create a Minimal Reproduction
|
||||||
|
|
||||||
|
@ -12,7 +12,7 @@ There is a range of different ways you might be able to contribute to the Nuxt e
|
|||||||
|
|
||||||
The Nuxt ecosystem includes many different projects and organizations. For example:
|
The Nuxt ecosystem includes many different projects and organizations. For example:
|
||||||
|
|
||||||
* [nuxt/](https://github.com/nuxt) - core repositories for the Nuxt framework itself. Currently [**nuxt/framework**](https://github.com/nuxt/framework) contains Nuxt 3 and [**nuxt/nuxt.js**](https://github.com/nuxt/nuxt.js) contains Nuxt 2.
|
* [nuxt/](https://github.com/nuxt) - core repositories for the Nuxt framework itself. [**nuxt/nuxt**](https://github.com/nuxt/nuxt) contains the Nuxt framework (both versions 2 and 3).
|
||||||
* [nuxt-community/](https://github.com/nuxt-community) - community-contributed and maintained modules and libraries. There is a [process to migrate a module](/docs/guide/going-further/modules/#joining-nuxt-community) to `nuxt-community`. While these modules have individual maintainers, they are not dependent on a single person.
|
* [nuxt-community/](https://github.com/nuxt-community) - community-contributed and maintained modules and libraries. There is a [process to migrate a module](/docs/guide/going-further/modules/#joining-nuxt-community) to `nuxt-community`. While these modules have individual maintainers, they are not dependent on a single person.
|
||||||
* [nuxt-contrib/](https://github.com/nuxt-contrib) - the previous home for libraries that are not specific to Nuxt but produced and used by the Nuxt team.
|
* [nuxt-contrib/](https://github.com/nuxt-contrib) - the previous home for libraries that are not specific to Nuxt but produced and used by the Nuxt team.
|
||||||
* [unjs/](https://github.com/unjs) - many of these libraries are used throughout the Nuxt ecosystem. They are designed to be universal libraries that are framework- and environment-agnostic. We welcome contributions and usage by other frameworks and projects.
|
* [unjs/](https://github.com/unjs) - many of these libraries are used throughout the Nuxt ecosystem. They are designed to be universal libraries that are framework- and environment-agnostic. We welcome contributions and usage by other frameworks and projects.
|
||||||
@ -21,7 +21,7 @@ The Nuxt ecosystem includes many different projects and organizations. For examp
|
|||||||
|
|
||||||
### Triage Issues and Help Out in Discussions
|
### Triage Issues and Help Out in Discussions
|
||||||
|
|
||||||
Check out the issues and discussions for the project you want to help. For example, here are [the issues board](https://github.com/nuxt/framework/issues) and [discussions](https://github.com/nuxt/framework/discussions) for Nuxt 3. Helping other users, sharing workarounds, creating reproductions, or even poking into a bug a little bit and sharing your findings makes a huge difference.
|
Check out the issues and discussions for the project you want to help. For example, here are [the issues board](https://github.com/nuxt/nuxt/issues) and [discussions](https://github.com/nuxt/nuxt/discussions) for Nuxt 3. Helping other users, sharing workarounds, creating reproductions, or even poking into a bug a little bit and sharing your findings makes a huge difference.
|
||||||
|
|
||||||
### Creating an Issue
|
### Creating an Issue
|
||||||
|
|
||||||
@ -55,7 +55,7 @@ Note that `fix:` and `feat:` are for **actual code changes** (that might affect
|
|||||||
|
|
||||||
* ~~`fix: typo`~~ -> `docs: fix typo`
|
* ~~`fix: typo`~~ -> `docs: fix typo`
|
||||||
|
|
||||||
If you are working in a project with a monorepo, like `nuxt/framework`, ensure that you specify the main scope of your commit in brackets. For example: `feat(nuxi): add 'do-magic' command`.
|
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`.
|
||||||
|
|
||||||
#### Making the Pull Request
|
#### Making the Pull Request
|
||||||
|
|
||||||
|
@ -1,11 +1,11 @@
|
|||||||
---
|
---
|
||||||
navigation.icon: octicon:repo-24
|
navigation.icon: octicon:repo-24
|
||||||
description: Some specific points about contributions to the nuxt/framework repository.
|
description: Some specific points about contributions to the nuxt/nuxt repository.
|
||||||
---
|
---
|
||||||
|
|
||||||
# nuxt/framework
|
# nuxt/nuxt
|
||||||
|
|
||||||
Once you've read the [general contribution guide](/docs/community/contribution), here are some specific points to make about contributions to the `nuxt/framework` repository.
|
Once you've read the [general contribution guide](/docs/community/contribution), here are some specific points to make about contributions to the `nuxt/nuxt` repository.
|
||||||
|
|
||||||
## Using the Playground
|
## Using the Playground
|
||||||
|
|
||||||
@ -43,7 +43,7 @@ Make the change directly in the GitHub interface and open a Pull Request.
|
|||||||
|
|
||||||
### Longer Edits
|
### Longer Edits
|
||||||
|
|
||||||
The documentation content is inside the `docs/` directory of the [nuxt/framework repository](https://github.com/nuxt/framework) and written in markdown.
|
The documentation content is inside the `docs/` directory of the [nuxt/nuxt repository](https://github.com/nuxt/nuxt) and written in markdown.
|
||||||
|
|
||||||
To contribute, fork the repository and follow [these steps](#set-up-documentation-website-in-local-environment) and start docs in development mode.
|
To contribute, fork the repository and follow [these steps](#set-up-documentation-website-in-local-environment) and start docs in development mode.
|
||||||
|
|
||||||
@ -60,7 +60,7 @@ Documentation is linted using [MarkdownLint](https://github.com/DavidAnson/markd
|
|||||||
|
|
||||||
To contribute to Nuxt, you need to set up a local environment.
|
To contribute to Nuxt, you need to set up a local environment.
|
||||||
|
|
||||||
1. [Fork](https://help.github.com/articles/fork-a-repo/) the [nuxt/framework repository](https://github.com/nuxt/framework) to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device.
|
1. [Fork](https://help.github.com/articles/fork-a-repo/) the [nuxt/nuxt repository](https://github.com/nuxt/nuxt) to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device.
|
||||||
|
|
||||||
1. Ensure using the latest Node.js (16.x)
|
1. Ensure using the latest Node.js (16.x)
|
||||||
|
|
||||||
|
@ -17,7 +17,7 @@ This page lists the current status and schedule of our planned releases.
|
|||||||
|
|
||||||
## 📝 Status Reports
|
## 📝 Status Reports
|
||||||
|
|
||||||
- [Documentation Progress](https://github.com/nuxt/framework/issues/4104)
|
- [Documentation Progress](https://github.com/nuxt/nuxt/issues/13653)
|
||||||
- [Rendering Optimizations: Today and Tomorrow](https://github.com/nuxt/framework/discussions/5856)
|
- [Rendering Optimizations: Today and Tomorrow](https://github.com/nuxt/framework/discussions/5856)
|
||||||
- [Nuxt Image: Performance and Status](https://github.com/nuxt/image/discussions/563)
|
- [Nuxt Image: Performance and Status](https://github.com/nuxt/image/discussions/563)
|
||||||
|
|
||||||
@ -29,8 +29,8 @@ The latest updates on Nuxt 2.x are available via the `nuxt-edge` npm package and
|
|||||||
|
|
||||||
Release | npm | Status | Last Release | Docs | Repository
|
Release | npm | Status | Last Release | Docs | Repository
|
||||||
---------|----|---------|--------------|------|-----------------
|
---------|----|---------|--------------|------|-----------------
|
||||||
Nuxt 3.x | [`nuxt`](https://npmjs.com/package/nuxt) | Stable | <a href="https://npmjs.com/package/nuxt"><img src="https://flat.badgen.net/npm/v/nuxt/rc"></a> | [3.x docs](https://v3.nuxtjs.org/) | [nuxt/framework](https://github.com/nuxt/framework)
|
Nuxt 3.x | [`nuxt`](https://npmjs.com/package/nuxt) | Stable | <a href="https://npmjs.com/package/nuxt"><img src="https://flat.badgen.net/npm/v/nuxt/rc"></a> | [3.x docs](https://v3.nuxtjs.org/) | [nuxt/nuxt](https://github.com/nuxt/nuxt)
|
||||||
Nuxt 3.x (edge*) | [`nuxt3`](https://npmjs.com/package/nuxt3) | Development | <a href="https://npmjs.com/package/nuxt3"><img src="https://flat.badgen.net/npm/v/nuxt3"></a> | [3.x docs](https://v3.nuxtjs.org/) | [nuxt/framework](https://github.com/nuxt/framework)
|
Nuxt 3.x (edge*) | [`nuxt3`](https://npmjs.com/package/nuxt3) | Development | <a href="https://npmjs.com/package/nuxt3"><img src="https://flat.badgen.net/npm/v/nuxt3"></a> | [3.x docs](https://v3.nuxtjs.org/) | [nuxt/nuxt](https://github.com/nuxt/nuxt)
|
||||||
Nuxt 2.x | [`nuxt`](https://npmjs.com/package/nuxt) | Maintenance | <a href="https://npmjs.com/package/nuxt"><img src="https://flat.badgen.net/npm/v/nuxt"></a> | [2.x docs](https://nuxtjs.org/docs) | [nuxt/nuxt.js#2.x](https://github.com/nuxt/nuxt.js/tree/2.x)
|
Nuxt 2.x | [`nuxt`](https://npmjs.com/package/nuxt) | Maintenance | <a href="https://npmjs.com/package/nuxt"><img src="https://flat.badgen.net/npm/v/nuxt"></a> | [2.x docs](https://nuxtjs.org/docs) | [nuxt/nuxt.js#2.x](https://github.com/nuxt/nuxt.js/tree/2.x)
|
||||||
Nuxt 2.x (edge*) | [`nuxt-edge`](https://npmjs.com/package/nuxt) | Maintenance | <a href="https://npmjs.com/package/nuxt-edge"><img src="https://flat.badgen.net/npm/v/nuxt-edge"></a> | [2.x docs](https://nuxtjs.org/docs) | [nuxt/nuxt.js](https://github.com/nuxt/nuxt.js)
|
Nuxt 2.x (edge*) | [`nuxt-edge`](https://npmjs.com/package/nuxt) | Maintenance | <a href="https://npmjs.com/package/nuxt-edge"><img src="https://flat.badgen.net/npm/v/nuxt-edge"></a> | [2.x docs](https://nuxtjs.org/docs) | [nuxt/nuxt.js](https://github.com/nuxt/nuxt.js)
|
||||||
|
|
||||||
@ -45,7 +45,7 @@ In roadmap below are the major expected features that are coming soon with Nuxt
|
|||||||
Milestone | Expected date | Notes | Description
|
Milestone | Expected date | Notes | Description
|
||||||
-------------|------------------|--------|-----------------------
|
-------------|------------------|--------|-----------------------
|
||||||
Image | 2022 | [nuxt/image#548](https://github.com/nuxt/image/discussions/548) | Stable image optimization for Nuxt 3
|
Image | 2022 | [nuxt/image#548](https://github.com/nuxt/image/discussions/548) | Stable image optimization for Nuxt 3
|
||||||
Test Utils | 2022 | [nuxt/framework#3198](https://github.com/nuxt/framework/issues/3198) | A rewrite of [nuxt/test-utils](https://github.com/nuxt/test-utils) for testing Nuxt 3 and new modules
|
Test Utils | 2022 | [nuxt/nuxt#13372](https://github.com/nuxt/nuxt/issues/13372) | A rewrite of [nuxt/test-utils](https://github.com/nuxt/test-utils) for testing Nuxt 3 and new modules
|
||||||
SEO & PWA | 2022 | [nuxt/framework#1823](https://github.com/nuxt/framework/discussions/1823) | Migrating from [nuxt-community/pwa-module](https://github.com/nuxt-community/pwa-module) for built-in SEO utils and service worker support
|
SEO & PWA | 2022 | [nuxt/framework#1823](https://github.com/nuxt/framework/discussions/1823) | Migrating from [nuxt-community/pwa-module](https://github.com/nuxt-community/pwa-module) for built-in SEO utils and service worker support
|
||||||
Scripts | - | [nuxt/framework#5856](https://github.com/nuxt/framework/discussions/5856) | Easy 3rd party script management.
|
Scripts | - | [nuxt/framework#5856](https://github.com/nuxt/framework/discussions/5856) | Easy 3rd party script management.
|
||||||
DevTools | - | - | Integrated and modular devtools experience for Nuxt
|
DevTools | - | - | Integrated and modular devtools experience for Nuxt
|
||||||
|
@ -84,7 +84,7 @@ icon: github-discussion
|
|||||||
#title
|
#title
|
||||||
GitHub discussion
|
GitHub discussion
|
||||||
#description
|
#description
|
||||||
We first recommend looking for your question on the [discussion board](https://github.com/nuxt/framework/discussions){ .font-semibold .text-green-400 }. Feel free to create a post if you can't find the answer.
|
We first recommend looking for your question on the [discussion board](https://github.com/nuxt/nuxt/discussions){ .font-semibold .text-green-400 }. Feel free to create a post if you can't find the answer.
|
||||||
::
|
::
|
||||||
::support-community-list
|
::support-community-list
|
||||||
---
|
---
|
||||||
|
@ -42,7 +42,7 @@ Nuxt wouldn’t be possible today without an amazing community making amazing mo
|
|||||||
|
|
||||||
Releasing Nuxt 3 is a big milestone for us and opens a future-proof basis for new ideas and trust for the users to build their enterprise projects with Nuxt 3.
|
Releasing Nuxt 3 is a big milestone for us and opens a future-proof basis for new ideas and trust for the users to build their enterprise projects with Nuxt 3.
|
||||||
|
|
||||||
Server Component Islands, WebSocket layer, new Deployment presets, improved CLI and DevTools and Testing infra are a few to mention. Keep an eye on the [roadmap page](https://nuxt.com/docs/community/roadmap) and [GitHub discussions](https://github.com/nuxt/framework/discussions) for updates.
|
Server Component Islands, WebSocket layer, new Deployment presets, improved CLI and DevTools and Testing infra are a few to mention. Keep an eye on the [roadmap page](https://nuxt.com/docs/community/roadmap) and [GitHub discussions](https://github.com/nuxt/nuxt/discussions) for updates.
|
||||||
|
|
||||||
NuxtLabs is working on [new product](https://nuxt.studio) and solutions on top of Nuxt 3 at the time of writing this article.
|
NuxtLabs is working on [new product](https://nuxt.studio) and solutions on top of Nuxt 3 at the time of writing this article.
|
||||||
|
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "nuxt-framework",
|
"name": "nuxt-framework",
|
||||||
"private": true,
|
"private": true,
|
||||||
"repository": "nuxt/framework",
|
"repository": "nuxt/nuxt",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "@nuxt/kit",
|
"name": "@nuxt/kit",
|
||||||
"version": "3.0.0",
|
"version": "3.0.0",
|
||||||
"repository": "nuxt/framework",
|
"repository": "nuxt/nuxt",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"main": "./dist/index.mjs",
|
"main": "./dist/index.mjs",
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "nuxi",
|
"name": "nuxi",
|
||||||
"version": "3.0.0",
|
"version": "3.0.0",
|
||||||
"repository": "nuxt/framework",
|
"repository": "nuxt/nuxt",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"types": "./dist/index.d.ts",
|
"types": "./dist/index.d.ts",
|
||||||
|
@ -89,10 +89,9 @@ export default defineNuxtCommand({
|
|||||||
console.log(`Nuxt project info: ${copied ? '(copied to clipboard)' : ''}\n\n${splitter}\n${infoStr}${splitter}\n`)
|
console.log(`Nuxt project info: ${copied ? '(copied to clipboard)' : ''}\n\n${splitter}\n${infoStr}${splitter}\n`)
|
||||||
|
|
||||||
const isNuxt3OrBridge = infoObj.NuxtVersion.startsWith('3') || infoObj.BuildModules.includes('bridge')
|
const isNuxt3OrBridge = infoObj.NuxtVersion.startsWith('3') || infoObj.BuildModules.includes('bridge')
|
||||||
const repo = isNuxt3OrBridge ? 'nuxt/framework' : 'nuxt/nuxt.js'
|
|
||||||
console.log([
|
console.log([
|
||||||
`👉 Report an issue: https://github.com/${repo}/issues/new`,
|
'👉 Report an issue: https://github.com/nuxt/nuxt/issues/new',
|
||||||
`👉 Suggest an improvement: https://github.com/${repo}/discussions/new`,
|
'👉 Suggest an improvement: https://github.com/nuxt/nuxt/discussions/new',
|
||||||
`👉 Read documentation: ${isNuxt3OrBridge ? 'https://nuxt.com' : 'https://nuxtjs.org'}`
|
`👉 Read documentation: ${isNuxt3OrBridge ? 'https://nuxt.com' : 'https://nuxtjs.org'}`
|
||||||
].join('\n\n') + '\n')
|
].join('\n\n') + '\n')
|
||||||
}
|
}
|
||||||
|
@ -67,7 +67,7 @@ export default defineNuxtCommand({
|
|||||||
const commitA = nuxtVersionToGitIdentifier(currentVersion)
|
const commitA = nuxtVersionToGitIdentifier(currentVersion)
|
||||||
const commitB = nuxtVersionToGitIdentifier(upgradedVersion)
|
const commitB = nuxtVersionToGitIdentifier(upgradedVersion)
|
||||||
if (commitA && commitB) {
|
if (commitA && commitB) {
|
||||||
consola.info('Changelog:', `https://github.com/nuxt/framework/compare/${commitA}...${commitB}`)
|
consola.info('Changelog:', `https://github.com/nuxt/nuxt/compare/${commitA}...${commitB}`)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -31,7 +31,7 @@ export const writeTypes = async (nuxt: Nuxt) => {
|
|||||||
...nuxt.options.typescript.includeWorkspace && nuxt.options.workspaceDir !== nuxt.options.rootDir ? [join(relative(nuxt.options.buildDir, nuxt.options.workspaceDir), '**/*')] : []
|
...nuxt.options.typescript.includeWorkspace && nuxt.options.workspaceDir !== nuxt.options.rootDir ? [join(relative(nuxt.options.buildDir, nuxt.options.workspaceDir), '**/*')] : []
|
||||||
],
|
],
|
||||||
exclude: [
|
exclude: [
|
||||||
// nitro generate output: https://github.com/nuxt/framework/blob/main/packages/nuxt/src/core/nitro.ts#L186
|
// nitro generate output: https://github.com/nuxt/nuxt/blob/main/packages/nuxt/src/core/nitro.ts#L186
|
||||||
relative(nuxt.options.buildDir, resolve(nuxt.options.rootDir, 'dist'))
|
relative(nuxt.options.buildDir, resolve(nuxt.options.rootDir, 'dist'))
|
||||||
]
|
]
|
||||||
})
|
})
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "nuxt",
|
"name": "nuxt",
|
||||||
"version": "3.0.0",
|
"version": "3.0.0",
|
||||||
"repository": "nuxt/framework",
|
"repository": "nuxt/nuxt",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"main": "./dist/index.mjs",
|
"main": "./dist/index.mjs",
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "@nuxt/schema",
|
"name": "@nuxt/schema",
|
||||||
"version": "3.0.0",
|
"version": "3.0.0",
|
||||||
"repository": "nuxt/framework",
|
"repository": "nuxt/nuxt",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"main": "./dist/index.mjs",
|
"main": "./dist/index.mjs",
|
||||||
|
@ -17,7 +17,7 @@ export default defineUntypedSchema({
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Externalize `vue`, `@vue/*` and `vue-router` when building.
|
* Externalize `vue`, `@vue/*` and `vue-router` when building.
|
||||||
* @see https://github.com/nuxt/framework/issues/4084
|
* @see https://github.com/nuxt/nuxt/issues/13632
|
||||||
*/
|
*/
|
||||||
externalVue: true,
|
externalVue: true,
|
||||||
|
|
||||||
@ -47,7 +47,7 @@ export default defineUntypedSchema({
|
|||||||
/**
|
/**
|
||||||
* Split server bundle into multiple chunks and dynamically import them.
|
* Split server bundle into multiple chunks and dynamically import them.
|
||||||
*
|
*
|
||||||
* @see https://github.com/nuxt/framework/issues/6432
|
* @see https://github.com/nuxt/nuxt/issues/14525
|
||||||
*/
|
*/
|
||||||
viteServerDynamicImports: true,
|
viteServerDynamicImports: true,
|
||||||
|
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "@nuxt/test-utils",
|
"name": "@nuxt/test-utils",
|
||||||
"version": "3.0.0",
|
"version": "3.0.0",
|
||||||
"repository": "nuxt/framework",
|
"repository": "nuxt/nuxt",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"exports": "./dist/index.mjs",
|
"exports": "./dist/index.mjs",
|
||||||
|
@ -7,7 +7,7 @@ export async function createBrowser () {
|
|||||||
|
|
||||||
let playwright: typeof import('playwright')
|
let playwright: typeof import('playwright')
|
||||||
try {
|
try {
|
||||||
// Workround for https://github.com/nuxt/framework/issues/3470
|
// Workround for https://github.com/nuxt/nuxt/issues/13441
|
||||||
// TODO: Remove when upstream issue resolved
|
// TODO: Remove when upstream issue resolved
|
||||||
playwright = await import(String('playwright'))
|
playwright = await import(String('playwright'))
|
||||||
} catch {
|
} catch {
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "@nuxt/vite-builder",
|
"name": "@nuxt/vite-builder",
|
||||||
"version": "3.0.0",
|
"version": "3.0.0",
|
||||||
"repository": "nuxt/framework",
|
"repository": "nuxt/nuxt",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"types": "./dist/index.d.ts",
|
"types": "./dist/index.d.ts",
|
||||||
|
@ -127,7 +127,7 @@ export async function bundle (nuxt: Nuxt) {
|
|||||||
|
|
||||||
if (
|
if (
|
||||||
nuxt.options.vite.warmupEntry !== false &&
|
nuxt.options.vite.warmupEntry !== false &&
|
||||||
// https://github.com/nuxt/framework/issues/7510
|
// https://github.com/nuxt/nuxt/issues/14898
|
||||||
!(env.isServer && ctx.nuxt.options.vite.devBundler !== 'legacy')
|
!(env.isServer && ctx.nuxt.options.vite.devBundler !== 'legacy')
|
||||||
) {
|
) {
|
||||||
const start = Date.now()
|
const start = Date.now()
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "@nuxt/webpack-builder",
|
"name": "@nuxt/webpack-builder",
|
||||||
"version": "3.0.0",
|
"version": "3.0.0",
|
||||||
"repository": "nuxt/framework",
|
"repository": "nuxt/nuxt",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"types": "./dist/index.d.ts",
|
"types": "./dist/index.d.ts",
|
||||||
|
@ -9,7 +9,7 @@ export function esbuild (ctx: WebpackConfigContext) {
|
|||||||
// https://nodejs.org/en/
|
// https://nodejs.org/en/
|
||||||
const target = ctx.isServer ? 'es2019' : 'chrome85'
|
const target = ctx.isServer ? 'es2019' : 'chrome85'
|
||||||
|
|
||||||
// https://github.com/nuxt/framework/issues/2372
|
// https://github.com/nuxt/nuxt/issues/13052
|
||||||
config.optimization!.minimizer!.push(new (esbuildLoader as unknown as typeof import('esbuild-loader')).ESBuildMinifyPlugin())
|
config.optimization!.minimizer!.push(new (esbuildLoader as unknown as typeof import('esbuild-loader')).ESBuildMinifyPlugin())
|
||||||
|
|
||||||
config.module!.rules!.push(
|
config.module!.rules!.push(
|
||||||
|
@ -90,7 +90,7 @@ describe('pages', () => {
|
|||||||
expect(html).toContain('[...slug].vue')
|
expect(html).toContain('[...slug].vue')
|
||||||
expect(html).toContain('404 at not-found')
|
expect(html).toContain('404 at not-found')
|
||||||
|
|
||||||
// Middleware still runs after validation: https://github.com/nuxt/framework/issues/9701
|
// Middleware still runs after validation: https://github.com/nuxt/nuxt/issues/15650
|
||||||
expect(html).toContain('Middleware ran: true')
|
expect(html).toContain('Middleware ran: true')
|
||||||
|
|
||||||
await expectNoClientErrors('/not-found')
|
await expectNoClientErrors('/not-found')
|
||||||
|
Loading…
Reference in New Issue
Block a user