docs: 更新部分表述,更新当前的功能列表 #12
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: Build Docs | |
on: | |
push: | |
paths: | |
- 'docs/**' | |
jobs: | |
doc: | |
if: ${{ github.ref == 'refs/heads/main' }} | |
name: Build documentation | |
runs-on: ubuntu-latest | |
defaults: | |
run: | |
working-directory: docs | |
steps: | |
- name: Checkout repo | |
uses: actions/checkout@v4 | |
- name: Setup bun | |
uses: oven-sh/setup-bun@v2 | |
with: | |
bun-version: latest | |
- name: Install dependencies | |
run: bun install --frozen-lockfile | |
- name: Cache dependencies | |
uses: actions/cache@v4 | |
with: | |
path: ~/.bun/install/cache | |
key: ${{ runner.os }}-bun-${{ hashFiles('docs/bun.lockb') }} | |
restore-keys: | | |
${{ runner.os }}-bun- | |
- name: Build documentation | |
run: bun run docs:build | |
- name: Deploy Github Pages | |
uses: peaceiris/actions-gh-pages@v4 | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: docs/.vitepress/dist | |
force_orphan: true | |
commit_message: 部署来自 main 的最新文档变更: |