Skip to content

Workflow file for this run

name: Deploy MkDocs to GitHub Pages
on:
push:
branches:
- SoftwareX # Adjust if your default branch is different
workflow_dispatch:
permissions:
contents: write
pages: write
id-token: write
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout Code
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.9'
- name: Install Dependencies
run: |
pip install mkdocs mkdocs-material mkdocstrings
- name: Build MkDocs Site
run: mkdocs build
- name: Upload Artifact
uses: actions/upload-pages-artifact@v3
with:
path: site
deploy:
runs-on: ubuntu-latest
needs: build
permissions:
pages: write
id-token: write
steps:
- name: Deploy to GitHub Pages
uses: actions/deploy-pages@v4