Deploy docs

.github/workflows/docs.yml

@@ -0,0 +1,61 @@
+name: Deploy Vitepress
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18.17.1
+          cache: npm
+
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.11
+          cache: pip
+
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip setuptools wheel
+          pip install -r requirements.txt
+          npm ci
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+
+      - name: Build with VitePress
+        run: |
+          npm run docs:build
+          touch docs/.vitepress/dist/.nojekyll
+
+      - name: Upload Artifacts
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: docs/.vitepress/dist
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

docs/.vitepress/config.mts

@@ -47,6 +47,8 @@ export default defineConfig({
   lastUpdated: true,
   cleanUrls: true,
 
+  ignoreDeadLinks: true,
+
   head: [['link', { rel: 'icon', type: 'image/x-icon', href: '/logo.ico' }]],
   themeConfig: {
     logo: '/logo.ico',

package.json

@@ -24,7 +24,9 @@
     "up": "taze major -I",
     "docs:gen:be": "python3 docs/generate_docs.py",
     "docs:gen:fe": "vue-docgen -c src/frontend/docgen.config.js",
-    "docs": "npm run docs:gen:be && npm run docs:gen:fe && vitepress dev docs"
+    "docs:gen": "npm run docs:gen:be && npm run docs:gen:fe",
+    "docs": "npm run docs:gen && vitepress dev docs",
+    "docs:build": "npm run docs:gen && vitepress build docs"
   },
   "dependencies": {
     "@vueuse/core": "^10.4.1",