deploy-mkdocs.yml

name: Deploy MkDocs to GitHub Pages

on:
  push:
    branches:
      - master
    paths-ignore:
      - 'README.md'
      - 'docs/all-articles.md'
      - 'docs/all-categories.md'
  workflow_dispatch:

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

concurrency:
  group: pages
  cancel-in-progress: true

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

      - name: Configure git for unicode paths
        run: git config core.quotepath false

      - name: Setup Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.x"

      - name: Configure Pages
        uses: actions/configure-pages@v5

      - name: Install dependencies
        run: |
          pip install mkdocs-material mkdocs-git-revision-date-localized-plugin mkdocs-git-authors-plugin gitpython jieba pyyaml mkdocs-glightbox mkdocs-minify-plugin

      - name: Generate README, all-articles, all-categories and mkdocs nav for build
        run: python scripts/generate_readme.py --target all

      - name: Check markdown docs and fail with precise file/line info
        run: python scripts/check_docs.py --strict --report-json artifacts/check-report.json --summary-md artifacts/check-summary.md

      - name: Prepare docs directory for MkDocs build
        run: python scripts/prepare_mkdocs_docs.py --source docs --output build_docs --mkdocs mkdocs.yml

      - name: Build site
        run: mkdocs build --strict --verbose

      - name: Append check summary
        if: always()
        run: |
          if [ -f artifacts/check-summary.md ]; then
            cat artifacts/check-summary.md >> "$GITHUB_STEP_SUMMARY"
          fi

      - name: Upload Pages artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: ./site

  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4