test(ci): add build workflow to catch build errors in CI (#469)

* test(ci): add build workflow to catch build errors in CI

* fix(build): add type modules to package.json to resolve ESM error

.github/workflows/build.yml

@@ -0,0 +1,22 @@
+name: Build VitePress Site
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          cache: yarn # or pnpm / npm
+      - name: Install dependencies
+        run: yarn install # or pnpm install / npm ci
+      - name: Build with VitePress
+        run: yarn docs:build # or pnpm docs:build / npm docs:build

README.md

@@ -1,3 +1,5 @@
+[![Deploy](https://github.com/rollkit/docs/actions/workflows/deploy.yml/badge.svg)](https://github.com/rollkit/docs/actions/workflows/deploy.yml)
+
 # Rollkit Documentation Site
 
 Welcome to the official documentation repository for Rollkit.

package.json

@@ -13,5 +13,6 @@
   },
   "dependencies": {
     "node-fetch": "^3.3.2"
-  }
+  },
+  "type": "module"
 }