Update README #18
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: Deploy MkDocs | |
on: | |
push: | |
branches: | |
- main # or your default branch name | |
pull_request: | |
branches: | |
- main | |
jobs: | |
deploy: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@v4 | |
- name: Set up Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: '3.x' | |
- name: Install MkDocs dependencies | |
run: | | |
python -m pip install --upgrade pip | |
pip install mkdocs mkdocs-material | |
- name: Deploy to GitHub Pages | |
working-directory: mkdocs | |
run: mkdocs gh-deploy --force |