快速上手

注意

请确保你的 Node.js 版本 >= 8。

全局安装

如果你只是想尝试一下 VuePress，你可以全局安装它：

  1. # 安装
  2. yarn global add vuepress@next # 或者：npm install -g vuepress@next
  4. # 新建一个 markdown 文件
  5. echo '# Hello VuePress!' > README.md
  7. # 开始写作
  8. vuepress dev .
  10. # 构建静态文件
  11. vuepress build .

现有项目

如果你想在一个现有项目中使用 VuePress，同时想要在该项目中管理文档，则应该将 VuePress 安装为本地依赖。作为本地依赖安装让你可以使用持续集成工具，或者一些其他服务（比如 Netlify）来帮助你在每次提交代码时自动部署。

  1. # 将 VuePress 作为一个本地依赖安装
  2. yarn add -D vuepress@next # 或者：npm install -D vuepress@next
  4. # 新建一个 docs 文件夹
  5. mkdir docs
  7. # 新建一个 markdown 文件
  8. echo '# Hello VuePress!' > docs/README.md
  10. # 开始写作
  11. npx vuepress dev docs

注意

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

接着，在 package.json 里加一些脚本:

  1. {
  2.   "scripts": {
  3.     "docs:dev": "vuepress dev docs",
  4.     "docs:build": "vuepress build docs"
  5.   }
  6. }

然后就可以开始写作了:

  1. yarn docs:dev # 或者：npm run docs:dev

要生成静态的 HTML 文件，运行：

  1. yarn docs:build # 或者：npm run docs:build

默认情况下，文件将会被生成在 .vuepress/dist，当然，你也可以通过 .vuepress/config.js 中的 dest 字段来修改，生成的文件可以部署到任意的静态文件服务器上，参考 部署 来了解更多。