快速上手

#快速上手 | 来源: 网络整理| 查看: 265

# 快速上手

前提条件

VuePress 需要 Node.js (opens new window) >= 8.6

本文会帮助你从头搭建一个简单的 VuePress 文档。如果你想在一个现有项目中使用 VuePress 管理文档，从步骤 3 开始。

创建并进入一个新目录

mkdir vuepress-starter && cd vuepress-starter

使用你喜欢的包管理器进行初始化

yarn init # npm init

将 VuePress 安装为本地依赖

我们已经不再推荐全局安装 VuePress

yarn add -D vuepress # npm install -D vuepress

注意

如果你的现有项目依赖了 webpack 3.x，我们推荐使用 Yarn (opens new window) 而不是 npm 来安装 VuePress。因为在这种情形下，npm 会生成错误的依赖树。

创建你的第一篇文档

mkdir docs && echo '# Hello VuePress' > docs/README.md

在 package.json 中添加一些 scripts (opens new window)

这一步骤是可选的，但我们推荐你完成它。在下文中，我们会默认这些 scripts 已经被添加。

{ "scripts": { "docs:dev": "vuepress dev docs", "docs:build": "vuepress build docs" } }

在本地启动服务器

yarn docs:dev # npm run docs:dev

VuePress 会在 http://localhost:8080 (opens new window) 启动一个热重载的开发服务器。

现在，你应该已经有了一个简单可用的 VuePress 文档。接下来，了解一下推荐的目录结构和 VuePress 中的基本配置。

等你了解完上文介绍的基础概念，再去学习一下如何使用静态资源，Markdown 拓展和在 Markdown 中使用 Vue 来丰富你的文档内容。

当你的文档逐渐成型的时候，不要忘记 VuePress 的多语言支持并了解一下如何将你的文档部署到任意静态文件服务器上。

在 GitHub 上编辑此页 (opens new window) 上次更新: 6/10/2020, 2:17:54 AM

← 介绍目录结构 →

【本文地址】

公司简介

联系我们