查看“VuePress快速开始”的源代码


<div class="warning">

VuePress v2 目前仍处于 <code>beta</code> 阶段。你已经可以用它来构建你的站点，但是它的配置和 API 还不够稳定，很可能会在 Minor 版本中发生 Breaking Changes 。因此，在每次更新 beta 版本之后，请一定要仔细阅读 [https://github.com/vuepress/vuepress-next/blob/main/CHANGELOG.md 更新日志]。


</div>
== 依赖环境 ==

* [https://nodejs.org/ Node.js v16.19.0+]


== 手动安装 ==

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

* '''步骤 1''': 创建并进入一个新目录

<pre lang="bash">mkdir vuepress-starter
cd vuepress-starter</pre>

* '''步骤 2''': 初始化项目

<pre lang="bash">git init
npm init</pre>

* '''步骤 3''': 将 VuePress 安装为本地依赖

<pre lang="bash">npm install -D vuepress@next</pre>

* '''步骤 4''': 在 <code>package.json</code> 中添加一些 [https://classic.yarnpkg.com/zh-Hans/docs/package-json#toc-scripts scripts]

<pre lang="json">{
  "scripts": {
    "docs:dev": "vuepress dev docs",
    "docs:build": "vuepress build docs"
  }
}</pre>

* '''步骤 5''': 将默认的临时目录和缓存目录添加到 <code>.gitignore</code> 文件中

<pre lang="bash">echo 'node_modules' >> .gitignore
echo '.temp' >> .gitignore
echo '.cache' >> .gitignore</pre>

* '''步骤 6''': 创建你的第一篇文档

<pre lang="bash">mkdir docs
echo '# Hello VuePress' > docs/README.md</pre>

* '''步骤 7''': 在本地启动服务器来开发你的文档网站

<pre lang="bash">npm run docs:dev</pre>



VuePress 会在 http://localhost:8080 启动一个热重载的开发服务器。当你修改你的 Markdown 文件时，浏览器中的内容也会自动更新。