发布 VuePress 网站到 github

省略新建github仓库、创建vuepress项目

修改 docs/.vuepress/config.js

module.exports = {
	...

    // 如果你打算发布到 https://<USERNAME or GROUP>.gitlab.io/，则可以省略这一步，因为 base 默认即是 "/"
    // 如果你打算发布到 https://<USERNAME or GROUP>.gitlab.io/<REPO>/（也就是说你的仓库在 https://gitlab.com/<USERNAME>/<REPO>），则将 base 设置为 "/<REPO>/"
    base: "/vuepress-starter/",

	...
}

项目根目录新建 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 git@github.com:<USERNAME>/<USERNAME>.github.io.git master

# 如果发布到 https://<USERNAME>.github.io/<REPO>
# git push -f git@github.com:<USERNAME>/<REPO>.git master:<BranchName>
git push -f git@github.com:yang-jia-liang/vuepress-starter.git master:gh-pages

cd -

# 发布到github page： 项目根目录 Git Bash Here -> yarn run deploy-gh

修改package.json

添加 "deploy": "bash deploy.sh"

{
  "devDependencies": {
    "vuepress": "^1.8.2"
  },
  "scripts": {
    "docs:dev": "vuepress dev docs",
    "docs:build": "vuepress build docs",
    "deploy": "bash deploy.sh"
  }
}

发布到github

1. 项目根目录中右键 Git Bash Here
2. 输入 yarn run deploy-gh
   
   

编辑github仓库设置

vuepress网站示例

在线示例地址
源码示例

发布过程中遇到的错误

1. Please make sure you have the correct access rights and the repository exists