Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: scaffold initial todo Vue docs #8

Merged
merged 1 commit into from
Aug 31, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
]
}
]
}
]
}
6 changes: 6 additions & 0 deletions docs/framework/vue/quick-start.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Quick Start
id: quick-start
---

# TODO
6 changes: 6 additions & 0 deletions docs/framework/vue/reference/useStore.md
Original file line number Diff line number Diff line change
@@ -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)
8 changes: 7 additions & 1 deletion docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.