vue cli 3.x 項目部署到 github pages

github pages 是 github 免費爲用戶提供的服務，寫博客，或者部署一些純靜態項目。

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

https://github.com/nusr/resume-vue

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 部署官方說明