feat: documentation

.github/workflows/playground.yml → .github/workflows/doc.yml

@@ -4,10 +4,11 @@ on:
     - main
 
 jobs:
-  deploy:
+  doc:
     runs-on: ubuntu-latest
     permissions:
       contents: write
+
     steps:
       - uses: actions/checkout@v4
       - run: corepack enable
@@ -16,11 +17,8 @@ jobs:
           node-version: 20
           cache: pnpm
       - run: pnpm install
-      - run: pnpm build
-        env:
-          PLAYGROUND: true
-          BASE_URL: /${{ github.event.repository.name }}
+      - run: pnpm doc
       - uses: peaceiris/actions-gh-pages@v4
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./playground/dist
+          publish_dir: ./doc

.github/workflows/release.yml

@@ -6,7 +6,6 @@ on:
 jobs:
   release:
     runs-on: ubuntu-latest
-
     permissions:
       pages: write
       id-token: write

.gitignore

@@ -10,6 +10,7 @@ lerna-debug.log*
 node_modules
 dist
 dist-ssr
+doc
 *.local
 
 # Editor directories and files

.npmrc

@@ -0,0 +1 @@
+enable-pre-post-scripts=true

package.json

@@ -30,10 +30,13 @@
     "dist"
   ],
   "scripts": {
-    "dev": "vite",
-    "build": "vue-tsc -b && vite build",
+    "dev": "vite --config vite.playground.config.ts",
+    "build": "vite build",
     "preview": "vite preview",
-    "release": "changelogen --release --push --publish"
+    "release": "changelogen --release --push --publish",
+    "doc": "typedoc",
+    "doc:serve": "typedoc --watch & serve doc",
+    "postdoc": "vite build --config vite.playground.config.ts"
   },
   "peerDependencies": {
     "vue": "^3.5.12"
@@ -42,6 +45,10 @@
     "@types/node": "^22.9.1",
     "@vitejs/plugin-vue": "^5.1.4",
     "changelogen": "^0.5.7",
+    "serve": "^14.2.4",
+    "typedoc": "^0.26.11",
+    "typedoc-github-theme": "^0.1.2",
+    "typedoc-plugin-vue": "^1.3.0",
     "typescript": "~5.6.2",
     "vite": "^5.4.10",
     "vite-plugin-dts": "^4.3.0",