Skip to content

Rebuild docs as React+MDX, replace Jekyll entirely #23

Rebuild docs as React+MDX, replace Jekyll entirely

Rebuild docs as React+MDX, replace Jekyll entirely #23

Workflow file for this run

name: Deploy Homepage & Documentation
on:
push:
branches: [ main ]
paths:
- 'docs/**'
- '.github/workflows/deploy-docs.yml'
pull_request:
branches: [ main ]
paths:
- 'docs/**'
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: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '20'
cache: 'npm'
cache-dependency-path: docs/package-lock.json
- name: Install npm dependencies
run: npm ci
working-directory: ./docs
- name: Build with Vite
run: npm run build
working-directory: ./docs
# SPA fallback for GitHub Pages client-side routing
- name: Create 404 fallback
run: cp docs/dist/index.html docs/dist/404.html
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./docs/dist
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
if: github.ref == 'refs/heads/main'
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4