main.yml

name: build and deploy mkdocs to github pages
on:
  push:
    branches:
      - master
jobs:
  deploy:
    runs-on: ubuntu-20.04
    steps:
      - uses: actions/checkout@v2
        with:
          submodules: "recursive" 
          fetch-depth: 0       # Fetch all history for .GitInfo and .Lastmod
      - name: Setup Python
        uses: actions/setup-python@v1
        with:
          python-version: '3.8'
          architecture: 'x64'
      - name: Install dependencies
        run: |
          python3 -m pip install --upgrade pip     # install pip
          python3 -m pip install -r requirements.txt
          #python3 -m pip install mkdocs            # install mkdocs 
          #python3 -m pip install mkdocs-material   # install material theme
          #python3 -m pip install mkdocs-redirects  # install mkdocs-redirects
          #python3 -m pip install markdown <3.4     # to avoid issue 3
          #python3 -m pip install markdown-fenced-code-tabs
          #python3 -m pip install mkdocs-rtd-dropdown
      - name: Build site
        run: mkdocs build
      - name: Deploy
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./site