This repository was archived by the owner on Aug 25, 2025. It is now read-only.
docs: update docs (#99) #31
This file contains hidden or 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: Deploy Docs | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| paths: | |
| - '.github/workflows/deploy-ghpage.yml' | |
| env: | |
| REPO_NAME: ${{ github.event.repository.name }} | |
| DEPLOY_PLATFORM: "github" | |
| jobs: | |
| deploy-gh-pages: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| # submodules: true | |
| - name: Install pnpm | |
| uses: pnpm/action-setup@v4 | |
| with: | |
| version: 9.15.9 | |
| run_install: false | |
| - name: Setup Node.js | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: 18 | |
| cache: pnpm | |
| - name: Install Deps | |
| run: pnpm install --frozen-lockfile | |
| - name: Build Docs | |
| env: | |
| NODE_OPTIONS: --max_old_space_size=8192 | |
| DEPLOY_PLATFORM: github | |
| run: |- | |
| pnpm run docs:build | |
| > docs/.vuepress/dist/.nojekyll | |
| - name: Upload Build Artifacts | |
| if: github.event_name == 'pull_request' | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| path: docs/.vuepress/dist | |
| - name: Deploy | |
| if: github.event_name == 'push' && github.ref == 'refs/heads/main' | |
| uses: peaceiris/actions-gh-pages@v4 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: docs/.vuepress/dist | |
| # cname: | |
| permissions: | |
| contents: write |