feat: 添加文档站 (#22) #2
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: 部署文档 | |
on: | |
push: | |
paths: | |
- '.github/workflows/deploy-docs.yml' | |
- 'docs/**' | |
pull_request: | |
paths: | |
- '.github/workflows/deploy-docs.yml' | |
- 'docs/**' | |
permissions: | |
contents: write | |
jobs: | |
deploy-gh-pages: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
# 如果你文档需要 Git 子模块,取消注释下一行 | |
submodules: true | |
- name: 设置 pnpm | |
uses: pnpm/action-setup@v4 | |
with: | |
version: 8 | |
- name: 设置 Node.js | |
uses: actions/setup-node@v4 | |
with: | |
node-version: latest | |
cache: pnpm | |
cache-dependency-path: docs/pnpm-lock.yaml | |
- name: 安装依赖 | |
run: | | |
cd docs | |
corepack enable | |
pnpm install --frozen-lockfile | |
- name: 构建文档 | |
env: | |
NODE_OPTIONS: --max_old_space_size=8192 | |
run: |- | |
cd docs | |
pnpm run docs:build | |
> src/.vuepress/dist/.nojekyll | |
- name: 部署文档 | |
uses: JamesIves/github-pages-deploy-action@v4 | |
with: | |
# 部署文档 | |
branch: gh-pages | |
folder: docs/src/.vuepress/dist |