Skip to content

Latest commit

 

History

History
122 lines (86 loc) · 3.04 KB

deploy.md

File metadata and controls

122 lines (86 loc) · 3.04 KB

部署

下述的指南基于以下条件：

  • 文档放置在项目的 docs 目录中；
  • 使用的是默认的构建输出位置；
  • VuePress 以本地依赖的形式被安装到你的项目中，并且配置了如下的 npm scripts:
{
  "scripts": {
    "docs:build": "vuepress build docs"
  }
}

GitHub Pages

  1. 在 docs/.vuepress/config.js 中设置正确的 base。

    如果你打算发布到 https://<USERNAME>.github.io/，则可以省略这一步，因为 base 默认即是 "/"。

    如果你打算发布到 https://<USERNAME>.github.io/<REPO>/（也就是说你的仓库在 https://github.com/<USERNAME>/<REPO>），则将 base 设置为 "/<REPO>/"。

  2. 在你的项目中，创建一个如下的 deploy.sh 文件（请自行判断去掉高亮行的注释）:

#!/usr/bin/env sh

# 确保脚本抛出遇到的错误
set -e

# 生成静态文件
npm run docs:build

# 进入生成的文件夹
cd docs/.vuepress/dist

# 如果是发布到自定义域名
# echo 'www.example.com' > CNAME

git init
git add -A
git commit -m 'deploy'

# 如果发布到 https://<USERNAME>.github.io
# git push -f [email protected]:<USERNAME>/<USERNAME>.github.io.git master

# 如果发布到 https://<USERNAME>.github.io/<REPO>
# git push -f [email protected]:<USERNAME>/<REPO>.git master:gh-pages

cd -

::: tip 你可以在你的持续集成的设置中，设置在每次 push 代码时自动运行上述脚本。 :::

GitLab Pages and GitLab CI

  1. 在 docs/.vuepress/config.js 中设置正确的 base。

    如果你打算发布到 https://<USERNAME or GROUP>.gitlab.io/，则可以省略这一步，因为 base 默认即是 "/"。

    如果你打算发布到 https://<USERNAME or GROUP>.gitlab.io/<REPO>/（也就是说你的仓库在 https://gitlab.com/<USERNAME>/<REPO>），则将 base 设置为 "/<REPO>/"。

  2. 在 .vuepress/config.js 中将 dest 设置为 public。

  3. 在你项目的根目录下创建一个名为 .gitlab-ci.yml 的文件，无论何时你提交了更改，它都会帮助你自动构建和部署：

image: node:9.11.1

pages:
 cache:
   paths:
   - node_modules/

 script:
 - npm install
 - npm run docs:build
 artifacts:
   paths:
   - public
 only:
 - master

Netlify

  1. 在 Netlify 中, 创建一个新的 Github 项目，使用以下设置：
  • Build Command: npm run build-docs 或者 yarn build-docs
  • Publish directory: docs/.vuepress/dist
  1. 点击 deploy 按钮！

Google Firebase

  1. 请确保你已经安装了 firebase-tools。

  2. 在你项目的根目录下创建 firebase.json 和 .firebaserc，并包含以下内容：

    firebase.json:

    {
  "hosting": {
    "public": "./docs/.vuepress/dist",
    "ignore": []
  }
}

    .firebaserc:

    {
  "projects": {
    "default": "<YOUR_FIREBASE_ID>"
  }
}

  3. 在执行了 yarn docs:build 或 npm run docs:build 后, 使用 firebase deploy 指令来部署。