mirror of
https://github.com/nuxt/nuxt.git
synced 2024-11-25 15:15:19 +00:00
docs: improve installation prerequisites
This commit is contained in:
parent
c56c9c6d7a
commit
c570ae2724
@ -1,15 +1,16 @@
|
|||||||
---
|
---
|
||||||
title: Documentation
|
title: Documentation
|
||||||
navigation: false
|
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.
|
||||||
---
|
---
|
||||||
|
|
||||||
<!-- markdownlint-disable -->
|
<!-- markdownlint-disable -->
|
||||||
<!-- @case-police-disable -->
|
<!-- @case-police-disable -->
|
||||||
::docs-hero
|
::docs-hero
|
||||||
#title
|
#title
|
||||||
Nuxt Docs
|
Nuxt Docs
|
||||||
#description
|
#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 }
|
::card-item{ .mt-4 }
|
||||||
|
@ -19,16 +19,19 @@ Start with one of our starters and themes directly by opening [nuxt.new](https:/
|
|||||||
|
|
||||||
## New Project
|
## 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
|
::alert
|
||||||
::details
|
::details
|
||||||
:summary[Before getting started, please make sure you have installed the recommended setup:]
|
:summary[Additional notes for an optimal setup:]
|
||||||
* **Node.js**<sup>*</sup> (latest LTS version or above 16.11) 👉 [[Download](https://nodejs.org/en/download/)]
|
- **Node.js**: Make sure to use an even numbered version (16, 18, etc)
|
||||||
* **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)]
|
|
||||||
|
|
||||||
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]
|
```ts [nuxt.config.ts]
|
||||||
export default defineNuxtConfig({
|
export default defineNuxtConfig({
|
||||||
|
Loading…
Reference in New Issue
Block a user