build and deploy mkdocs to github pages #470
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 and deploy mkdocs to github pages | |
on: | |
# schedule: | |
# - cron: '30 5,17 * * *' | |
workflow_dispatch: | |
push: | |
branches: | |
- master | |
jobs: | |
deploy: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
submodules: "recursive" | |
fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod | |
- name: Setup Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: '3.7' | |
architecture: 'x64' | |
- name: Install dependencies | |
run: | | |
python3 -m pip install --upgrade pip # install pip | |
python3 -m pip install mkdocs # install mkdocs | |
python3 -m pip install mkdocs-material # install material theme | |
python3 -m pip install mkdocs-git-revision-date-localized-plugin | |
python3 -m pip install mkdocs-minify-plugin | |
python3 -m pip install mkdocs-macros-plugin | |
- name: Build site | |
run: mkdocs build | |
- name: Deploy | |
uses: peaceiris/actions-gh-pages@v3 | |
with: | |
personal_token: ${{ secrets.GH_SECRET }} | |
publish_dir: ./site |