Skip to content

Workflow file for this run

name: Deploy MkDocs Site to GitHub Pages
on: [push, pull_request]
permissions: write-all
jobs:
build-deploy:
runs-on: ubuntu-latest
steps:
- name: Copy contents to docs/
run: |
mkdir docs/
- name: Checkout main branch
uses: actions/checkout@v3
with:
ref: main
path: docs
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: "3.x"
- name: Install Dependencies
run: pip install -r requirements.txt
- name: Build the Site
run: mkdocs build --clean
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_branch: gh-pages
publish_dir: ./site