Change to vitepress

.dockerignore

@@ -34,4 +34,5 @@ LICENSE
 README.md
 
 /config/
-/logs/
+/logs/
+/docs/

.github/workflows/docs-deployment.yaml

@@ -9,12 +9,8 @@ on:
       - 'docs/**'
 
 jobs:
-  deploy:
+  build:
     runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      deployments: write
-    name: Deploy to Cloudflare Pages
     steps:
         - uses: actions/checkout@v4
 
@@ -24,15 +20,27 @@ jobs:
             cache: 'npm'
 
         - run: npm ci
-          working-directory: ./docs
 
-        - run: npm run build
-          working-directory: ./docs
+        - run: npm run docs:build
+
+        - name: Upload artifact
+          uses: actions/upload-artifact@v4
+          with:
+            name: docs
+            path: docs/.vitepress/dist
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+        - uses: actions/download-artifact@v4
+          with:
+            name: docs
+            path: docs
 
         - name: Deploy
           uses: cloudflare/wrangler-action@v3
           with:
-            workingDirectory: "docs"
             apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
             accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
-            command: pages deploy build --project-name=open-dynamic-export
+            command: pages deploy docs --project-name=open-dynamic-export

.gitignore

@@ -127,4 +127,8 @@ dist
 .yarn/unplugged
 .yarn/build-state.yml
 .yarn/install-state.gz
-.pnp.*
+.pnp.*
+
+# Vitepress
+docs/.vitepress/dist
+docs/.vitepress/cache

docs/.vitepress/config.ts

@@ -0,0 +1,43 @@
+import { defineConfig } from 'vitepress';
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+    title: 'Open Dynamic Export',
+    description: 'Free open-source inverter curtailment',
+    appearance: 'force-dark',
+    themeConfig: {
+        // https://vitepress.dev/reference/default-theme-config
+        logo: '/logo.svg',
+
+        nav: [
+            { text: 'Home', link: '/' },
+            { text: 'Guide', link: '/guide' },
+        ],
+
+        sidebar: [
+            {
+                text: 'Guide',
+                items: [
+                    { text: 'Introduction', link: '/introduction' },
+                    { text: 'Getting started', link: '/getting-started' },
+                    { text: 'Configuration', link: '/configuration' },
+                    { text: 'Supported devices', link: '/supported-devices' },
+                ],
+            },
+            {
+                text: 'CSIP-AUS',
+                items: [
+                    { text: 'Queensland', link: '/csip-qld' },
+                    { text: 'Other states', link: '/csip-other' },
+                ],
+            },
+        ],
+
+        socialLinks: [
+            {
+                icon: 'github',
+                link: 'https://github.com/longzheng/open-dynamic-export',
+            },
+        ],
+    },
+});

docs/.vitepress/theme/custom.css

@@ -0,0 +1,7 @@
+/* .vitepress/theme/custom.css */
+:root {
+    --vp-c-brand-1: #42F35D;
+    --vp-c-brand-2: #37D64F;
+    --vp-c-brand-3: #2CB941;
+    --vp-c-brand-soft: #58B366;
+  }

docs/.vitepress/theme/index.ts

@@ -0,0 +1,4 @@
+import DefaultTheme from 'vitepress/theme';
+import './custom.css';
+
+export default DefaultTheme;