Skip to content

docs: migrate from Jekyll to MkDocs and expand documentation #1

docs: migrate from Jekyll to MkDocs and expand documentation

docs: migrate from Jekyll to MkDocs and expand documentation #1

Workflow file for this run

name: docs
on:
push:
branches: [ main ]
paths:
- "docs/**"
- "mkdocs.yml"
- ".github/workflows/docs.yml"
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.11"
- name: Install MkDocs
run: |
python -m pip install --upgrade pip
pip install mkdocs mkdocs-material
- name: Build site
run: mkdocs build --strict
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: site
deploy:
runs-on: ubuntu-latest
needs: build
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4