Skip to content

up

up #24

Workflow file for this run

name: Deploy Documentation
on:
push:
branches:
- main
paths:
- 'docs/**'
- 'README.md'
- 'mkdocs.yml'
permissions:
contents: read
pages: write
id-token: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Setup Python
uses: actions/setup-python@v4
with:
python-version: '3.x'
- name: Install mkdocs and plugins
run: |
pip install mkdocs-material
pip install mkdocs-mermaid2-plugin
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Build site
run: mkdocs build
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: 'site'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2