部署到 github
假设你整个项目已经关联到 github 仓库
1:根目录创建一个deploy.sh 文件
md
#!/usr/bin/env sh
# 确保脚本抛出遇到的错误
set -e
# 生成静态文件
pnpm run docs:build
# 进入生成的文件夹
cd docs/.vitepress/dist
# 如果是发布到自定义域名
echo 'vitepress.huaxiaobao.top' > 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> https://github.com/huaxiaobao/vitepress.git
git push -f git@github.com:huaxiaobao/vitepress.git master:gh-pages
cd -2: 根目录创建一个.travis.yml文件
md
language: node_js
node_js:
- lts/*
install:
- pnpm install # npm ci
script:
- pnpm docs:build # npm run docs:build
- pnpm cname
deploy:
provider: pages
skip_cleanup: true
local_dir: my-vitepress/docs/.vitepress/dist
github_token: $GITHUB_TOKEN # 在 GitHub 中生成,用于允许 Travis 向你的仓库推送代码。在 Travis 的项目设置页面进行配置,设置为 secure variable
keep_history: true
on:
branch: master3:根目录创建一个 .cname.sh 文件
md
# cname.sh
set -e
#注意修改成自己的域名,修改文件夹目录
echo 'vitepress.huaxiaobao.top' > my-vitepress/dist/CNAME4:配置 packge,json 配置如下脚本
json
"deploy": "bash deploy.sh"5:在 git 中运行如下命令
git
yarn deploy6:在 github 对应仓库找到 setting 设置,然后选择 page 页面,一步步填写(注意,自己的域名地址需要先做好DNS 解析),然后 github 会生产一个文档地址,这时就可以正常访问了。