vue cli 3.x 專案部署到 github pages

github pages 是 github 免費為使用者提供的服務，寫部落格，或者部署一些純靜態專案。

最近將 vue cli 3.x 初始化專案部署到 github pages，踩了一些坑，記錄如下。

github.com/nusr/resume…

1. vue-router 不要開啟 history 模式

路徑中的 # 比較醜，就開啟了 vue-router 的 history 模式，去掉了 #。平時做專案也是預設開啟 history 模式。折騰了半天發現，我這是部署到 github pages ，伺服器沒有配置，導致頁面一直請求不到。

2. 配置 publicUrl

打包路徑也要單獨配置，否則也是請求不到頁面。

比如我的專案地址是 https://github.com/nusr/resume-vue

我要部署到 https://nusr.github.io/resume-vue，那麼 publicPath 要配置為 /resume-vue

// vue.config.js
module.exports = {
  publicPath: process.env.NODE_ENV === "production" ? "/resume-vue" : "/"
};
複製程式碼

3. css 引入圖片錯誤

css 引入背景圖片時，開發環境沒有任何問題，但是一旦部署後，就無法獲取圖片了。

稍微改下 App.vue 的程式碼，暫時解決了這個問題。

<!--App.vue-->
<template>
  <div id="app">
    <router-view />
  </div>
</template>
<script>
export default {
  name: "App",
  mounted() {
    /**
     * 解決 css 引入圖片在 github pages 無法獲取的問題
     */
    const { NODE_ENV } = process.env;
    document.documentElement.className = NODE_ENV;
  }
};
</script>
<style lang="less">
@import "~@/assets/global.less";
</style>
複製程式碼

給 html 標籤配置了一個頂級類，寫上不同的 css 解決了這個問題。

真時的部署環境不是這樣的，部署資料夾就是根目錄，但 github pages 部署資料夾不是根目錄，就有這個問題。

// global.less
.development {
  background-image: url(/background.png);
}

.production {
  background-image: url(/resume-vue/background.png)
}
複製程式碼

4. 自動部署指令碼

根目錄下新建 deploy.sh 檔案，檔案內容如下。

# deploy.sh
# 錯誤時停止
set -e

# 打包
npm run build

# 進入目標資料夾
cd dist

# 提交到本地倉庫

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

# 提交到 https://github.com:nusr/resume-vue 專案的 gh-pages 分支
git push -f git@github.com:nusr/resume-vue.git master:gh-pages

cd -
複製程式碼

部署命令是 bash deploy.sh

開啟 github pages

建立倉庫，倉庫名稱是 username.github.io ,必須是這種格式。

比如我的使用者名稱是 nusr,建立的倉庫就是 nusr.github.io。

github pages 預設開啟分支是 gh-pages,可以進入該倉庫頁面，點選 Settings -> GitHub Pages,切換展示的分支。

GitHub Pages 支援定製域名,支援 jsonp 請求。

參考

1. github pages 官方說明
2. vue cli 3.x 部署官方說明