Skip to content

docs: copying installation commands made easy #8101

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

Merged
merged 1 commit into from
Sep 26, 2024
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
18 changes: 13 additions & 5 deletions docs/eslint/eslint-plugin-query.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,19 @@ TanStack Query comes with its own ESLint plugin. This plugin is used to enforce
The plugin is a separate package that you need to install:

```bash
$ npm i -D @tanstack/eslint-plugin-query@4
# or
$ pnpm add -D @tanstack/eslint-plugin-query@4
# or
$ yarn add -D @tanstack/eslint-plugin-query@4
npm i -D @tanstack/eslint-plugin-query@4
```

or

```bash
pnpm add -D @tanstack/eslint-plugin-query@4
```

or

```bash
yarn add -D @tanstack/eslint-plugin-query@4
```

## Usage
Expand Down
18 changes: 13 additions & 5 deletions docs/framework/react/community/liaoliao666-react-query-kit.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,19 @@ This module is distributed via [NPM](https://www.npmjs.com/package/react-query-k
should be installed as one of your project's `dependencies`:

```bash
$ npm i react-query-kit
# or
$ pnpm add react-query-kit
# or
$ yarn add react-query-kit
npm i react-query-kit
```

or

```bash
pnpm add react-query-kit
```

or

```bash
yarn add react-query-kit
```

## Quick start with nextjs
Expand Down
18 changes: 13 additions & 5 deletions docs/framework/react/community/lukemorales-query-key-factory.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,19 @@ Typesafe query key management with auto-completion features. Focus on writing an
You can install Query Key Factory via [NPM](https://www.npmjs.com/package/@lukemorales/query-key-factory).

```bash
$ npm i @lukemorales/query-key-factory
# or
$ pnpm add @lukemorales/query-key-factory
# or
$ yarn add @lukemorales/query-key-factory
npm i @lukemorales/query-key-factory
```

or

```bash
pnpm add @lukemorales/query-key-factory
```

or

```bash
yarn add @lukemorales/query-key-factory
```


Expand Down
18 changes: 13 additions & 5 deletions docs/framework/react/community/suspensive-react-query.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,19 @@ You don't even need to use the isSuccess flag.
You can install @suspensive/react-query via [NPM](https://www.npmjs.com/package/@suspensive/react-query).

```bash
$ npm i @suspensive/react-query
# or
$ pnpm add @suspensive/react-query
# or
$ yarn add @suspensive/react-query
npm i @suspensive/react-query
```

or

```bash
pnpm add @suspensive/react-query
```

or

```bash
yarn add @suspensive/react-query
```

### Motivation
Expand Down
18 changes: 13 additions & 5 deletions docs/framework/react/devtools.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,19 @@ The devtools are a separate package that you need to install.
The major version of all the packages must be in sync.

```bash
$ npm i @tanstack/react-query-devtools@4
# or
$ pnpm add @tanstack/react-query-devtools@4
# or
$ yarn add @tanstack/react-query-devtools@4
npm i @tanstack/react-query-devtools@4
```

or

```bash
pnpm add @tanstack/react-query-devtools@4
```

or

```bash
yarn add @tanstack/react-query-devtools@4
```

You can import the devtools like this:
Expand Down
36 changes: 26 additions & 10 deletions docs/framework/react/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,19 @@ or a good ol' `<script>` via
### NPM

```bash
$ npm i @tanstack/react-query
# or
$ pnpm add @tanstack/react-query
# or
$ yarn add @tanstack/react-query
npm i @tanstack/react-query@4
```

or

```bash
pnpm add @tanstack/react-query@4
```

or

```bash
yarn add @tanstack/react-query@4
```

React Query is compatible with React v16.8+ and works with ReactDOM and React Native.
Expand Down Expand Up @@ -53,9 +61,17 @@ Opera >= 53
It is recommended to also use our [ESLint Plugin Query](../../../eslint/eslint-plugin-query) to help you catch bugs and inconsistencies while you code. You can install it via:

```bash
$ npm i -D @tanstack/eslint-plugin-query
# or
$ pnpm add -D @tanstack/eslint-plugin-query
# or
$ yarn add -D @tanstack/eslint-plugin-query
npm i -D @tanstack/eslint-plugin-query@4
```

or

```bash
pnpm add -D @tanstack/eslint-plugin-query@4
```

or

```bash
yarn add -D @tanstack/eslint-plugin-query@4
```
18 changes: 13 additions & 5 deletions docs/framework/svelte/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,19 @@ You can install Svelte Query via [NPM](https://npmjs.com).
### NPM

```bash
$ npm i @tanstack/svelte-query
# or
$ pnpm add @tanstack/svelte-query
# or
$ yarn add @tanstack/svelte-query
npm i @tanstack/svelte-query
```

or

```bash
pnpm add @tanstack/svelte-query
```

or

```bash
yarn add @tanstack/svelte-query
```

> Wanna give it a spin before you download? Try out the [basic](../examples/basic) example!
18 changes: 13 additions & 5 deletions docs/framework/vue/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,19 @@ You can install Vue Query via [NPM](https://npmjs.com).
### NPM

```bash
$ npm i @tanstack/vue-query
# or
$ pnpm add @tanstack/vue-query
# or
$ yarn add @tanstack/vue-query
npm i @tanstack/vue-query
```

or

```bash
pnpm add @tanstack/vue-query
```

or

```bash
yarn add @tanstack/vue-query
```

> Wanna give it a spin before you download? Try out the [basic](../examples/basic) example!
Expand Down
18 changes: 13 additions & 5 deletions packages/vue-query/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,19 @@ Visit https://tanstack.com/query/v4/docs/adapters/vue-query
1. Install `vue-query`

```bash
$ npm i @tanstack/vue-query
# or
$ pnpm add @tanstack/vue-query
# or
$ yarn add @tanstack/vue-query
npm i @tanstack/vue-query
```

or

```bash
pnpm add @tanstack/vue-query
```

or

```bash
yarn add @tanstack/vue-query
```

> If you are using Vue 2.6, make sure to also setup [@vue/composition-api](https://github.com/vuejs/composition-api)
Expand Down
Loading