diff --git a/.github/assets/banner.svg b/.github/assets/banner.svg new file mode 100644 index 0000000000..9a7abed71b --- /dev/null +++ b/.github/assets/banner.svg @@ -0,0 +1 @@ + diff --git a/README.md b/README.md index f5ea693f94..156b8e3525 100644 --- a/README.md +++ b/README.md @@ -1,113 +1,52 @@ +[![Nuxt banner](./.github/assets/banner.svg)](https://nuxt.com) -[![Nuxt banner](./.github/assets/banner.png)](https://nuxt.com) +# Nuxt -# πŸ‘‹ Welcome to Nuxt - - -Nuxt's goal is to make web development intuitive and performant, with a great developer experience.
Learn more in the ['What is Nuxt?'](https://nuxt.com/docs/getting-started/introduction) section of our documentation. - - -

+

Version Downloads License - Website - Volta board -

+ Website + Discord +

- - - - - - - - - - - - - - - - - - - - -
-
-
- - 		-

Documentation

-

- We highly recommend you take a look at the Nuxt documentation to level up. -

-
-
- - 		-

Modules

-

- Discover our list of modules to supercharge your Nuxt project. Created by the Nuxt team and community. -

-
-
- - 		-

Examples

-

- Explore different ways of using Nuxt features and get inspired with our list of examples. -

-
+Nuxt is a free and open-source framework with an intuitive and extendable way to create type-safe, performant and production-grade full-stack web applications and websites with Vue.js. - - - - - - - - - - - - - - - - - - - - -
-
-
- - 		-

Reporting bugs

-

- Check out the Reporting Bugs page.

-

-
-
- - 		-

Suggestions

-

- Check out the Contribution page. -

-
-
- - 		-

Questions

-

- Check out the Getting Help page. -

-
+It provides a number of features that make it easy to build fast, SEO-friendly, and scalable web applications, including: +- Server-side rendering, Static Site Generation or Hybrid Rendering +- Automatic routing with code-splitting +- State management +- SEO Optimization +- Extandable with [100+ modules](https://nuxt.com/modules) +- Deployment to a variety of hosting platforms +- ...[and much more](https://nuxt.com) πŸš€ + +## Getting Started + +Use the following command to create a new starter project. This will create a starter project with all the necessary files and dependencies: + +```bash +npx nuxi@latest nuxi init +``` + +Discover also [nuxt.new](https://nuxt.new): Open a Nuxt starter on CodeSandbox, StackBlitz or locally to get up and running in a few seconds. + +## Documentation + +We highly recommend you take a look at the [Nuxt documentation](https://nuxt.com/docs) to level up. It’s a great resource for learning more about the framework. It covers everything from getting started to advanced topics. + +## Modules + +Discover our [list of modules](https://nuxt.com/modules) to supercharge your Nuxt project, created by the Nuxt team and community. + +## Contribute + +We invite you to contribute and help improve Nuxt πŸ’š + +Here are a few ways you can get involved: +- **Reporting Bugs:** If you come across any bugs or issues, please check out the [reporting bugs guide](https://nuxt.com/docs/community/reporting-bugs) to learn how to submit a bug report. +- **Suggestions:** Have ideas to enhance Nuxt? We'd love to hear them! Check out the [contribution guide](https://nuxt.com/docs/community/contribution#creating-an-issue) to share your suggestions. +- **Questions:** If you have questions or need assistance, the [getting help guide](https://nuxt.com/docs/community/getting-help) provides resources to help you out. ## Local Development diff --git a/docs/2.guide/2.directory-structure/1.pages.md b/docs/2.guide/2.directory-structure/1.pages.md index dec282c074..3caab9c2ae 100644 --- a/docs/2.guide/2.directory-structure/1.pages.md +++ b/docs/2.guide/2.directory-structure/1.pages.md @@ -205,7 +205,7 @@ If you want more control over when the `` component is re-rendered (fo ``` diff --git a/docs/2.guide/2.directory-structure/3.app.md b/docs/2.guide/2.directory-structure/3.app.md index dc8a5744ec..da3facadba 100644 --- a/docs/2.guide/2.directory-structure/3.app.md +++ b/docs/2.guide/2.directory-structure/3.app.md @@ -34,7 +34,7 @@ If you have a [`pages/`](/docs/guide/directory-structure/pages) directory, to di ``` ::alert{type=danger} -Since Nuxt 3 uses [``](https://vuejs.org/guide/built-ins/suspense.html#suspense) inside ``, it cannot be set as a root element. +Since `` internally uses the [``](https://vuejs.org/guide/built-ins/suspense.html#suspense) component, `` cannot be set as a root element. :: ::alert{type=warning} diff --git a/docs/3.api/2.components/2.nuxt-page.md b/docs/3.api/2.components/2.nuxt-page.md index 19b5878b7b..9d050c5c86 100644 --- a/docs/3.api/2.components/2.nuxt-page.md +++ b/docs/3.api/2.components/2.nuxt-page.md @@ -34,6 +34,12 @@ For example, passing `static` key, `NuxtPage` component is rendered only once wh ``` +You can also use a dynamic key based on the current route. (Don't use `$route` object here as it can cause problems with how `` renders pages with ``.) + +```html + +``` + Alternatively, `pageKey` can be passed as a `key` value via `definePageMeta` from the `