aboutsummaryrefslogtreecommitdiff
path: root/.github/workflows/mkdocs-deploy.yml
blob: af6e50d3160e8448fa4f6afe14e8deca5f950c03 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
name: Deploy MkDocs to GitHub

on:
  push:
    branches:
      - main
    paths:
      - 'docs/**'
      - 'mkdocs.yml'
      - '.github/workflows/mkdocs-deploy.yml'
  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout 源码
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: 设置 Python 环境
        uses: actions/setup-python@v5
        with:
          python-version: '3.13'
          cache: 'pip'

      - name: 安装 MkDocs 及依赖
        run: |
          python -m pip install --upgrade pip
          pip install mkdocs mkdocs-material

      - name: 构建 MkDocs 站点
        run: mkdocs build

      # 官方标准Pages部署步骤,无需跨仓库
      - name: Setup Pages
        uses: actions/configure-pages@v5
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: ./site
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v5