From c570ae2724541b911cee6d92c996927e51a68e3e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Chopin?= Date: Wed, 15 Mar 2023 15:28:56 +0100 Subject: [PATCH] docs: improve installation prerequisites --- docs/0.index.md | 5 +++-- docs/1.getting-started/2.installation.md | 17 ++++++++++------- 2 files changed, 13 insertions(+), 9 deletions(-) diff --git a/docs/0.index.md b/docs/0.index.md index f32ea71095..923a6060e0 100644 --- a/docs/0.index.md +++ b/docs/0.index.md @@ -1,15 +1,16 @@ --- title: Documentation navigation: false -description: Learn everything you need to know, from beginner to master. +description: Learn everything you need to know about Nuxt, from beginner to master. --- + ::docs-hero #title Nuxt Docs #description -Nuxt is an open-source framework under MIT license for building modern and performant web applications that can be deployed on any platform running JavaScript. +Nuxt is a free and [open-source framework](https://github.com/nuxt/nuxt) with an intuitive and extendable way to create type-safe, performant and production-grade full-stack web applications and websites with [Vue.js](https://vuejs.org). :: ::card-item{ .mt-4 } diff --git a/docs/1.getting-started/2.installation.md b/docs/1.getting-started/2.installation.md index 294f195c31..84d63278ad 100644 --- a/docs/1.getting-started/2.installation.md +++ b/docs/1.getting-started/2.installation.md @@ -19,16 +19,19 @@ Start with one of our starters and themes directly by opening [nuxt.new](https:/ ## New Project +#### Prerequisites +- **Node.js** - [`v16.10.0`](https://nodejs.org/en/) or newer +- **Text editor** - We recommend [Visual Studio Code]() with the [Volar Extension](https://marketplace.visualstudio.com/items?itemName=Vue.volar) +- **Terminal** - In order to run Nuxt commands + ::alert ::details - :summary[Before getting started, please make sure you have installed the recommended setup:] - * **Node.js*** (latest LTS version or above 16.11) 👉 [[Download](https://nodejs.org/en/download/)] - * **Visual Studio Code** 👉 [[Download](https://code.visualstudio.com/)] - * **Volar Extension** 👉 [[Download](https://marketplace.visualstudio.com/items?itemName=Vue.volar)] - * Either enable [**Take Over Mode**](https://vuejs.org/guide/typescript/overview.html#volar-takeover-mode) (recommended) - * ... or add **TypeScript Vue Plugin (Volar)** 👉 [[Download](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin)] + :summary[Additional notes for an optimal setup:] + - **Node.js**: Make sure to use an even numbered version (16, 18, etc) - If you have enabled **Take Over Mode** or installed the **TypeScript Vue Plugin (Volar)**, you can disable generating the shim for `*.vue` files in your `nuxt.config` file: + - **Volar**: Either enable [**Take Over Mode**](https://vuejs.org/guide/typescript/overview.html#volar-takeover-mode) (recommended) or add the [TypeScript Vue Plugin](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) + + If you have enabled **Take Over Mode** or installed the **TypeScript Vue Plugin (Volar)**, you can disable generating the shim for `*.vue` files in your `nuxt.config.ts` file: ```ts [nuxt.config.ts] export default defineNuxtConfig({