dumi站点部署到github pages

01.非根目录部署

github pages 开启后，默认的地址是 https://<USERNAME>.github.io/

但是当你是第二个要用github pages的时候，默认就是 https://<USERNAME>.github.io/<REPO>/

所以我们需要配置一下，把起始路由和静态资源的起始路径调整

我们把base和publicPath都设置成 /<REPO>/就可以了。

export default {
  base: '/文档起始路由',
  publicPath: '/静态资源起始路径/',
  exportStatic: {}, // 将所有路由输出为 HTML 目录结构，以免刷新页面时 404
  // 其他配置
};

手动部署用到了gh-pages这个库

#首先执行
yarn docs:build
# 部署到github pages
yarn docs:deploy

02.配置github actions，push触发后发布

如果每次我们更新代码后都要手动运行命令部署就太麻烦了。

可以配置github actions，让他在我们push到master后帮我们部署。

新建 .github/workflows/gh-pages.yml 文件

name: github pages

on:
  push:
    branches:
      - master # default branch

jobs:
  deploy:
    runs-on: ubuntu-18.04
    steps:
      - uses: actions/checkout@v2
      - run: npm install
      - run: npm run docs:build
      - name: Deploy
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./docs-dist