您正在浏览 Nuxt 2 文档。前往 Nuxt 3 文档, 或了解更多关于 Nuxt 2 长期支持

安装

这里介绍如何通过 4 个步骤启动并运行 Nuxt 项目。


在线演练场

可以直接在 CodeSandbox 或 StackBlitz 上在线体验 Nuxt:

在 CodeSandbox 中试用 在 StackBlitz 中试用

前提条件

使用 create-nuxt-app

为了快速开始,可以使用 create-nuxt-app

确保已安装 yarn 或 npx(npx 从 npm 5.2 起默认提供),或 npm v6.1 以上。

Yarn
yarn create nuxt-app <project-name>
NPX
npx create-nuxt-app <project-name>
NPM
npm init nuxt-app <project-name>

启动后会出现一些问题(名称、Nuxt 选项、UI 框架、TypeScript、代码检查、测试框架等)。要了解所有选项,请查看 create-nuxt-app 文档

回答完所有问题后,所有依赖项将被安装。下一步是进入项目文件夹并启动项目:

Yarn
cd <project-name>
yarn dev
NPM
cd <project-name>
npm run dev

应用程序现在运行在 http://localhost:3000

另一种开始使用 Nuxt 的方式是使用 CodeSandbox ,这是快速体验 Nuxt 或与他人分享代码的好方法。

手动安装

只需一个文件和一个目录就可以从头创建 Nuxt 项目。

本例中使用终端创建目录和文件,但您也可以用喜欢的编辑器创建。

项目设置

首先创建一个以项目名称命名的空目录并进入:

mkdir <project-name>
cd <project-name>

<project-name> 替换为您的项目名称。

创建 package.json

touch package.json

用编辑器打开 package.json 并填入以下 JSON 内容:

package.json
{
  "name": "my-app",
  "scripts": {
    "dev": "nuxt",
    "build": "nuxt build",
    "generate": "nuxt generate",
    "start": "nuxt start"
  }
}

scripts 定义了通过 npm run <command>yarn <command> 启动的 Nuxt 命令。

什么是 package.json 文件?

package.json 就像项目的身份证。如果不了解 package.json 文件,建议阅读 npm 文档

安装 Nuxt

创建 package.json 后,通过 npmyarnnuxt 添加到项目中:

Yarn
yarn add nuxt
NPM
npm install nuxt

此命令将 nuxt 作为依赖项添加到项目中,并自动添加到 package.json。同时会创建 node_modules 目录,存储已安装的包和依赖项。

还会创建 yarn.lockpackage-lock.json,确保项目中安装的包具有一致的安装和兼容的依赖关系。

创建第一个页面

Nuxt 将 pages 目录中的所有 *.vue 文件转换为应用程序的路由。

在项目中创建 pages 目录:

mkdir pages

然后在 pages 目录中创建 index.vue 文件:

touch pages/index.vue

将此页面命名为 index.vue 很重要,这是 Nuxt 默认显示的页面。这是主页,必须命名为 index。

用编辑器打开 index.vue 文件并添加以下内容:

pages/index.vue
<template>
  <h1>Hello world!</h1>
</template>

启动项目

在终端中输入以下命令之一运行项目:

Yarn
yarn dev
NPM
npm run dev
以开发模式启动应用程序时使用 dev 命令。

应用程序现在运行在 http://localhost:3000

点击终端中的链接打开浏览器,将看到上一步复制的"Hello World"文本。

以开发模式启动 Nuxt 时,它会监听大多数目录中的文件变化,因此添加新页面时无需重启应用程序。
运行 dev 命令时会创建 .nuxt 文件夹,应将此文件夹加入版本控制的忽略列表。在根目录创建 .gitignore 文件并添加 .nuxt 即可忽略 .nuxt 文件夹中的文件。

额外步骤

pages 目录中创建名为 fun.vue 的页面。

添加 <template></template> 并在标签内放入有趣文字的标题。

然后在浏览器中访问新页面 localhost:3000/fun

创建名为 more-fun 的目录并在其中放入 index.vue 文件,效果与创建 more-fun.vue 文件相同。
Edit this page on GitHub Updated at Tue, Apr 14, 2026