This repository was archived by the owner on Sep 29, 2025. It is now read-only.
update readme doc #76
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: GitHub Pages | |
| on: | |
| push: | |
| branches: | |
| - master # Set a branch name to trigger deployment | |
| pull_request: | |
| jobs: | |
| deploy: | |
| runs-on: ubuntu-20.04 | |
| steps: | |
| - uses: actions/checkout@v2 | |
| with: | |
| fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod | |
| - name: Setup Python | |
| uses: actions/setup-python@v2 | |
| with: | |
| python-version: '3.8' | |
| - name: Install dependencies | |
| run: | | |
| python3 -m pip install mkdocs # install mkdocs | |
| python3 -m pip install mkdocs-material # install material theme | |
| - name: Build mkdocs | |
| run: | | |
| sed -i 's/zh-branded/zh/g' docs/mkdocs.zh.yml | |
| sed -i 's/en-branded/en/g' docs/mkdocs.en.yml | |
| mkdocs build -f ./docs/mkdocs.en.yml | |
| mkdocs build -f ./docs/mkdocs.zh.yml | |
| cp -av ./docs/index.html ./docs/site | |
| - name: Deploy | |
| uses: peaceiris/actions-gh-pages@v3 | |
| if: ${{ github.ref == 'refs/heads/master' }} | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./docs/site |