Merge pull request #8 from TanStack/add-vue-docs-scaffolding

docs: scaffold initial todo Vue docs
TanStack · Aug 31, 2023 · ed6f2a8 · ed6f2a8
2 parents 12d66c2 + d33d16c
commit ed6f2a8
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 1 deletion.
diff --git a/docs/config.json b/docs/config.json
@@ -51,6 +51,29 @@
           ]
         }
       ]
+    },
+    {
+      "framework": "vue",
+      "menuItems": [
+        {
+          "label": "Getting Started",
+          "children": [
+            {
+              "label": "Quick Start",
+              "to": "framework/vue/quick-start"
+            }
+          ]
+        },
+        {
+          "label": "API Reference",
+          "children": [
+            {
+              "label": "useStore",
+              "to": "framework/vue/reference/useStore"
+            }
+          ]
+        }
+      ]
     }
   ]
 }
diff --git a/docs/framework/vue/quick-start.md b/docs/framework/vue/quick-start.md
@@ -0,0 +1,6 @@
+---
+title: Quick Start
+id: quick-start
+---
+
+# TODO
diff --git a/docs/framework/vue/reference/useStore.md b/docs/framework/vue/reference/useStore.md
@@ -0,0 +1,6 @@
+---
+title: Use Store
+id: useStore
+---
+
+Please see [/packages/vue-store/src/index.tsx](https://github.com/tanstack/store/tree/main/packages/vue-store/src/index.ts)
diff --git a/docs/installation.md b/docs/installation.md
@@ -13,4 +13,10 @@ npm install @tanstack/react-store
 
 TanStack Store is compatible with React v16.8+ and is currently only compatible with ReactDOM only. If you would like to contribute to the React Native adapter, please reach out to us on [Discord](https://tlinz.com/discord).
 
-## Vue
+## Vue
+
+```sh
+npm install @tanstack/vue-store
+```
+
+TanStack Store is compatible with Vue 2 and 3.