Skip to content

Workflow file for this run

name: Deploy MkDocs to GitHub Pages
on:
push:
branches:
- main
pull_request:
branches:
- main
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: 3.x
- name: Install dependencies
run: pip install -r requirements.txt
- name: Install plugins from TonyCrane
run: |
git clone https://github.com/TonyCrane/mkdocs-toolchain
pip install mkdocs-toolchain/mkdocs-toc-plugin
rm -rf mkdocs-toolchain
- name: Build site
run: mkdocs build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
if: github.ref == 'refs/heads/main'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./site