From fbdea2a335e78e34441f7793f51e333992d6f576 Mon Sep 17 00:00:00 2001 From: Antoine ZANARDI Date: Wed, 6 Mar 2024 23:12:27 +0100 Subject: [PATCH 1/3] docs(readme): improve readme readability with table of contents, anchors and icons --- README.md | 38 ++++++++++++++++++++++++++------------ 1 file changed, 26 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 1289880ae07b..f263b9a13f1e 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,21 @@ It provides a number of features that make it easy to build fast, SEO-friendly, - Deployment to a variety of [hosting platforms](https://nuxt.com/deploy) - ...[and much more](https://nuxt.com) πŸš€ -## Getting Started +### Table of Contents + +1. [πŸš€ Getting Started](#-getting-started) +2. [πŸ’» Vue Development](#-vue-development) +3. [πŸ“– Documentation](#-documentation) +4. [🧩 Modules](#-modules) +5. [🀲🏼 Contribute](#-contribute) +6. [🏠 Local Development](#-local-development) +7. [⛰️ Nuxt 2](#-nuxt-2) +8. [πŸ”— Follow us](#-follow-us) +9. [©️ License](#-license) + +--- + +## πŸš€ 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: @@ -30,9 +44,10 @@ Use the following command to create a new starter project. This will create a st npx nuxi@latest 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. +> [!TIP] +> 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. -## Vue Development +## πŸ’» Vue Development Simple, intuitive and powerful, Nuxt lets you write Vue components in a way that makes sense. Every repetitive task is automated, so you can focus on writing your full-stack Vue application with confidence. @@ -54,7 +69,7 @@ useSeoMeta({ - ``` -## Documentation +## πŸ“– 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 +## 🧩 Modules Discover our [list of modules](https://nuxt.com/modules) to supercharge your Nuxt project, created by the Nuxt team and community. -## Contribute +## 🀲🏼 Contribute We invite you to contribute and help improve Nuxt πŸ’š @@ -79,21 +94,20 @@ Here are a few ways you can get involved: - **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 +## 🏠 Local Development Follow the docs to [Set Up Your Local Development Environment](https://nuxt.com/docs/community/framework-contribution#setup) to contribute to the framework and documentation. -## Nuxt 2 +## ⛰️ Nuxt 2 You can find the code for Nuxt 2 on the [`2.x` branch](https://github.com/nuxt/nuxt/tree/2.x) and the documentation at [v2.nuxt.com](https://v2.nuxt.com). -## Follow us +## πŸ”— Follow us

Discord  Twitter  GitHub

-## License +## ©️ License [MIT](./LICENSE) - From e3847044db05dd436d55c890cdd8fcdf14a859ee Mon Sep 17 00:00:00 2001 From: Antoine ZANARDI Date: Wed, 6 Mar 2024 23:18:03 +0100 Subject: [PATCH 2/3] docs(readme): improve readme readability with table of contents, anchors and icons --- README.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index f263b9a13f1e..1272a0a61356 100644 --- a/README.md +++ b/README.md @@ -24,19 +24,19 @@ It provides a number of features that make it easy to build fast, SEO-friendly, ### Table of Contents -1. [πŸš€ Getting Started](#-getting-started) -2. [πŸ’» Vue Development](#-vue-development) -3. [πŸ“– Documentation](#-documentation) -4. [🧩 Modules](#-modules) -5. [🀲🏼 Contribute](#-contribute) -6. [🏠 Local Development](#-local-development) -7. [⛰️ Nuxt 2](#-nuxt-2) -8. [πŸ”— Follow us](#-follow-us) -9. [©️ License](#-license) +1. [πŸš€ Getting Started](#getting-started) +2. [πŸ’» Vue Development](#vue-development) +3. [πŸ“– Documentation](#documentation) +4. [🧩 Modules](#modules) +5. [❀️ Contribute](#contribute) +6. [🏠 Local Development](#local-development) +7. [⛰️ Nuxt 2](#nuxt-2) +8. [πŸ”— Follow us](#follow-us) +9. [βš–οΈ License](#license) --- -## πŸš€ Getting Started +## πŸš€ 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: @@ -47,7 +47,7 @@ npx nuxi@latest init > [!TIP] > 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. -## πŸ’» Vue Development +## πŸ’» Vue Development Simple, intuitive and powerful, Nuxt lets you write Vue components in a way that makes sense. Every repetitive task is automated, so you can focus on writing your full-stack Vue application with confidence. @@ -77,15 +77,15 @@ useSeoMeta({ ``` -## πŸ“– Documentation +## πŸ“– 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 +## 🧩 Modules Discover our [list of modules](https://nuxt.com/modules) to supercharge your Nuxt project, created by the Nuxt team and community. -## 🀲🏼 Contribute +## ❀️ Contribute We invite you to contribute and help improve Nuxt πŸ’š @@ -94,20 +94,20 @@ Here are a few ways you can get involved: - **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 +## 🏠 Local Development Follow the docs to [Set Up Your Local Development Environment](https://nuxt.com/docs/community/framework-contribution#setup) to contribute to the framework and documentation. -## ⛰️ Nuxt 2 +## ⛰️ Nuxt 2 You can find the code for Nuxt 2 on the [`2.x` branch](https://github.com/nuxt/nuxt/tree/2.x) and the documentation at [v2.nuxt.com](https://v2.nuxt.com). -## πŸ”— Follow us +## πŸ”— Follow us

Discord  Twitter  GitHub

-## ©️ License +## βš–οΈ License [MIT](./LICENSE) From c9052506cd5213e56aabe371f8853638969f1986 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Chopin?= Date: Thu, 7 Mar 2024 00:33:23 +0100 Subject: [PATCH 3/3] Update README.md --- README.md | 32 +++++++++++++++++--------------- 1 file changed, 17 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 1272a0a61356..5481321e39ad 100644 --- a/README.md +++ b/README.md @@ -13,26 +13,28 @@ 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. 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 -- Auto imports -- Extensible with [180+ modules](https://nuxt.com/modules) +- Server-side rendering, Static Site Generation, Hybrid Rendering and Edge-Side Rendering +- Automatic routing with code-splitting and pre-fetching +- Data fetching and state management +- SEO Optimization and Meta tags definition +- Auto imports of components, composables and utils +- TypeScript with zero configuration +- Go fullstack with our server/ directory +- Extensible with [200+ modules](https://nuxt.com/modules) - Deployment to a variety of [hosting platforms](https://nuxt.com/deploy) - ...[and much more](https://nuxt.com) πŸš€ ### Table of Contents -1. [πŸš€ Getting Started](#getting-started) -2. [πŸ’» Vue Development](#vue-development) -3. [πŸ“– Documentation](#documentation) -4. [🧩 Modules](#modules) -5. [❀️ Contribute](#contribute) -6. [🏠 Local Development](#local-development) -7. [⛰️ Nuxt 2](#nuxt-2) -8. [πŸ”— Follow us](#follow-us) -9. [βš–οΈ License](#license) +- πŸš€ [Getting Started](#getting-started) +- πŸ’» [ Vue Development](#vue-development) +- πŸ“– [Documentation](#documentation) +- 🧩 [Modules](#modules) +- ❀️ [Contribute](#contribute) +- 🏠 [Local Development](#local-development) +- ⛰️ [Nuxt 2](#nuxt-2) +- πŸ”— [Follow us](#follow-us) +- βš–οΈ [License](#license) ---