Skip to content
docs

docs: add MkDocs documentation site with Diátaxis structure #3

Sign in to view logs

docs: add MkDocs documentation site with Diátaxis structure

docs: add MkDocs documentation site with Diátaxis structure #3

Workflow file for this run

.github/workflows/docs.yml at 3624a22
name: docs
on:
pull_request:
paths:
- docs/**
- mkdocs.yml
push:
branches:
- master
paths:
- docs/**
- mkdocs.yml
permissions:
contents: read
concurrency:
group: pages
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: astral-sh/setup-uv@v4
- name: Build docs
run: uv run --with mkdocs-material==9.7.6 mkdocs build --strict
- uses: actions/upload-pages-artifact@v3
with:
path: site
deploy:
if: github.event_name == 'push' && github.ref == 'refs/heads/master'
needs: build
runs-on: ubuntu-latest
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- uses: actions/configure-pages@v5
- id: deployment
uses: actions/deploy-pages@v4