feat: add vitepress docs

Author: OrbisK

.gitignore

@@ -8,6 +8,7 @@ node_modules
 .temp
 .tmp
 .cache
+**/.vitepress/cache
 
 # Yarn
 **/.yarn/cache

docs/.vitepress/config.ts

@@ -0,0 +1,38 @@
+import { resolve } from 'node:path'
+import { defineConfig } from 'vitepress'
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  title: 'vue-composable-starter',
+  description: 'A Vue Composable',
+  vite: {
+    resolve: {
+      alias: [
+        {
+          find: 'vue-composable-starter',
+          replacement: resolve(__dirname, '../../src/index.ts'),
+        },
+      ],
+    },
+  },
+  themeConfig: {
+    // https://vitepress.dev/reference/default-theme-config
+    nav: [
+      { text: 'Home', link: '/' },
+      { text: 'Examples', link: '/api-examples' },
+    ],
+
+    sidebar: [
+      {
+        text: 'Examples',
+        items: [
+          { text: 'Runtime API Examples', link: '/api-examples' },
+        ],
+      },
+    ],
+
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/vuejs/vitepress' },
+    ],
+  },
+})

docs/api-examples.md

@@ -0,0 +1,15 @@
+---
+outline: deep
+---
+
+# EXAMPLE
+
+<<< @/example.vue
+
+## Results
+
+<script setup>
+import Example from './example.vue'
+</script>
+
+<Example />

docs/example.vue

@@ -0,0 +1,11 @@
+<script setup>
+import { useToggle } from 'vue-composable-starter'
+
+const [toggleable, toggle] = useToggle()
+</script>
+
+<template>
+  <button :style="{ background: toggleable ? 'green' : 'red' }" @click="toggle">
+    Toggle: {{ toggleable }}
+  </button>
+</template>

docs/index.md

@@ -0,0 +1,21 @@
+---
+# https://vitepress.dev/reference/default-theme-home-page
+layout: home
+
+hero:
+  name: "vue-composable-starter"
+  text: "A Vue Composable"
+  tagline: My great project tagline
+  actions:
+    - theme: brand
+      text: API Examples
+      link: /api-examples
+
+features:
+  - title: Feature A
+    details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
+  - title: Feature B
+    details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
+  - title: Feature C
+    details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
+---

package.json

@@ -51,7 +51,10 @@
     "dev:vite": "pnpm --filter playgrounds-vite dev",
     "build:nuxt": "nuxi build playgrounds",
     "start:nuxt": "nuxi preview playgrounds",
-    "prepare:nuxt": "pnpm --filter playgrounds-nuxt prepare:nuxt"
+    "prepare:nuxt": "pnpm --filter playgrounds-nuxt prepare:nuxt",
+    "docs:dev": "vitepress dev docs",
+    "docs:build": "vitepress build docs",
+    "docs:preview": "vitepress preview docs"
   },
   "peerDependencies": {
     "vue": ">=3.0.0"
@@ -67,6 +70,7 @@
     "lint-staged": "^15.2.10",
     "typescript": "^5.6.3",
     "unbuild": "^2.0.0",
+    "vitepress": "^1.5.0",
     "vitest": "^2.1.4"
   },
   "gitHooks": {