Delete docs/videos directory #10
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 Site | |
# Trigger the workflow on push to specific files | |
on: | |
push: | |
paths: | |
- 'docs/**' # Trigger when any files in the 'docs' folder are updated | |
branches: | |
- main # Replace 'main' with your default branch if different | |
jobs: | |
deploy: | |
runs-on: ubuntu-latest | |
steps: | |
# Step 1: Check out the repository | |
- name: Checkout Code | |
uses: actions/checkout@v3 | |
# Step 2: Set up Python | |
- name: Set up Python | |
uses: actions/setup-python@v4 | |
with: | |
python-version: '3.9' # Compatible Python version for MkDocs | |
# Step 3: Install dependencies | |
- name: Install MkDocs and Dependencies | |
run: | | |
python -m pip install --upgrade pip | |
pip install mkdocs-material | |
# Step 4: Build the MkDocs Site | |
- name: Build MkDocs Site | |
run: mkdocs build # This generates the site into the 'site/' directory | |
# Step 5: Deploy to GitHub Pages | |
- name: Deploy to GitHub Pages | |
uses: peaceiris/actions-gh-pages@v4 | |
with: | |
personal_token: ${{ secrets.PAT_TOKEN }} # Use your PAT from secrets | |
publish_dir: ./site # The default directory for MkDocs build | |
publish_branch: gh-pages # GitHub Pages will host from the 'gh-pages' branch |