docs: add example to docs website

.github/workflows/deploy-docs.yaml

@@ -32,12 +32,16 @@ jobs:
         timeout-minutes: 5
         continue-on-error: true
         with:
-          path: node_modules
+          path: |
+            node_modules
+            example/node_modules
           key: ${{ runner.OS }}-modules-${{ hashFiles('**/package-lock.json') }}
           restore-keys: |
             ${{ runner.OS }}-modules-
       - name: install modules
-        run: npm install --no-audit --force --loglevel=error --no-update-notifier
+        run: |
+          npm install --no-audit --force --loglevel=error --no-update-notifier
+          cd example && npm install --no-audit --force --loglevel=error --no-update-notifier
       - name: Build vitepress
         run: npm run docs:build
       - name: Upload artifact

.gitignore

@@ -2,4 +2,5 @@ dist
 node_modules
 docs/.vitepress/dist
 docs/.vitepress/cache
+docs/public/todo-example
 .DS_Store

example/next.config.js

@@ -1,4 +1,12 @@
 /** @type {import('next').NextConfig} */
-const nextConfig = {}
+const nextConfig = {
+  output: 'export',
+  eslint: {
+    ignoreDuringBuilds: true,
+  },
+  typescript: {
+    ignoreBuildErrors: true,
+  },
+}
 
 module.exports = nextConfig

package.json

@@ -9,7 +9,7 @@
     "build": "rimraf dist && unbuild",
     "type-check": "tsc --noEmit",
     "docs:dev": "vitepress dev docs",
-    "docs:build": "vitepress build docs",
+    "docs:build": "(cd example && npm run build) && cp -R example/out docs/public/todo-example && vitepress build docs",
     "docs:preview": "vitepress preview docs"
   },
   "repository": {