chore: add documentation using vitepress

.github/workflows/deploy-documentation.yml

@@ -0,0 +1,63 @@
+# Sample workflow for building and deploying a VitePress site to GitHub Pages
+#
+name: Deploy VitePress site to Pages
+
+on:
+  # Runs on pushes targeting the `main` branch. Change this to `master` if you're
+  # using the `master` branch as the default branch.
+  push:
+    branches: [main]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Not needed if lastUpdated is not enabled
+      - uses: pnpm/action-setup@v3 # Uncomment this if you're using pnpm
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: pnpm
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Install dependencies
+        run: pnpm install
+      - name: Build with VitePress
+        run: pnpm docs:build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/.vitepress/dist
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

package.json

@@ -7,13 +7,17 @@
     "commit": "commit",
     "tailwindbuddy:release": "pnpm --filter './packages/core' release",
     "tailwindbuddy:test": "pnpm --filter './packages/core' test:ci",
-    "tailwindbuddy:build": "pnpm --filter './packages/core' build"
+    "tailwindbuddy:build": "pnpm --filter './packages/core' build",
+    "docs:dev": "vitepress dev packages/documentation",
+    "docs:build": "vitepress build packages/documentation",
+    "docs:preview": "vitepress preview packages/documentation"
   },
   "devDependencies": {
     "@commitlint/cli": "^19.2.1",
     "@commitlint/config-conventional": "^19.1.0",
     "@commitlint/prompt-cli": "^19.2.0",
-    "husky": "3.1.0"
+    "husky": "3.1.0",
+    "vitepress": "^1.3.4"
   },
   "husky": {
     "hooks": {

packages/documentation/.vitepress/cache/deps/_metadata.json

@@ -0,0 +1,40 @@
+{
+  "hash": "4283f11e",
+  "configHash": "786fcf03",
+  "lockfileHash": "a8ccead4",
+  "browserHash": "d25116ee",
+  "optimized": {
+    "vue": {
+      "src": "../../../../../node_modules/.pnpm/[email protected][email protected]/node_modules/vue/dist/vue.runtime.esm-bundler.js",
+      "file": "vue.js",
+      "fileHash": "66c140bf",
+      "needsInterop": false
+    },
+    "vitepress > @vue/devtools-api": {
+      "src": "../../../../../node_modules/.pnpm/@[email protected]/node_modules/@vue/devtools-api/dist/index.js",
+      "file": "vitepress___@vue_devtools-api.js",
+      "fileHash": "90eed972",
+      "needsInterop": false
+    },
+    "vitepress > @vueuse/core": {
+      "src": "../../../../../node_modules/.pnpm/@[email protected][email protected][email protected]_/node_modules/@vueuse/core/index.mjs",
+      "file": "vitepress___@vueuse_core.js",
+      "fileHash": "db00abbe",
+      "needsInterop": false
+    },
+    "@theme/index": {
+      "src": "../../../../../node_modules/.pnpm/[email protected]_@[email protected]_@[email protected]_@[email protected]_postcss@_2aekxe2sbooqp2zuwhekukj7iy/node_modules/vitepress/dist/client/theme-default/index.js",
+      "file": "@theme_index.js",
+      "fileHash": "60e166df",
+      "needsInterop": false
+    }
+  },
+  "chunks": {
+    "chunk-APRVKGGT": {
+      "file": "chunk-APRVKGGT.js"
+    },
+    "chunk-56R7HN57": {
+      "file": "chunk-56R7HN57.js"
+    }
+  }
+}