Skip to content

Commit 92e5672

Browse files
docs: copying installation commands made easy (#8101)
1 parent 542528a commit 92e5672

File tree

9 files changed

+130
-50
lines changed

9 files changed

+130
-50
lines changed

docs/eslint/eslint-plugin-query.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,19 @@ TanStack Query comes with its own ESLint plugin. This plugin is used to enforce
1010
The plugin is a separate package that you need to install:
1111

1212
```bash
13-
$ npm i -D @tanstack/eslint-plugin-query@4
14-
# or
15-
$ pnpm add -D @tanstack/eslint-plugin-query@4
16-
# or
17-
$ yarn add -D @tanstack/eslint-plugin-query@4
13+
npm i -D @tanstack/eslint-plugin-query@4
14+
```
15+
16+
or
17+
18+
```bash
19+
pnpm add -D @tanstack/eslint-plugin-query@4
20+
```
21+
22+
or
23+
24+
```bash
25+
yarn add -D @tanstack/eslint-plugin-query@4
1826
```
1927

2028
## Usage

docs/framework/react/community/liaoliao666-react-query-kit.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,19 @@ This module is distributed via [NPM](https://www.npmjs.com/package/react-query-k
1919
should be installed as one of your project's `dependencies`:
2020

2121
```bash
22-
$ npm i react-query-kit
23-
# or
24-
$ pnpm add react-query-kit
25-
# or
26-
$ yarn add react-query-kit
22+
npm i react-query-kit
23+
```
24+
25+
or
26+
27+
```bash
28+
pnpm add react-query-kit
29+
```
30+
31+
or
32+
33+
```bash
34+
yarn add react-query-kit
2735
```
2836

2937
## Quick start with nextjs

docs/framework/react/community/lukemorales-query-key-factory.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,19 @@ Typesafe query key management with auto-completion features. Focus on writing an
1010
You can install Query Key Factory via [NPM](https://www.npmjs.com/package/@lukemorales/query-key-factory).
1111

1212
```bash
13-
$ npm i @lukemorales/query-key-factory
14-
# or
15-
$ pnpm add @lukemorales/query-key-factory
16-
# or
17-
$ yarn add @lukemorales/query-key-factory
13+
npm i @lukemorales/query-key-factory
14+
```
15+
16+
or
17+
18+
```bash
19+
pnpm add @lukemorales/query-key-factory
20+
```
21+
22+
or
23+
24+
```bash
25+
yarn add @lukemorales/query-key-factory
1826
```
1927

2028

docs/framework/react/community/suspensive-react-query.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,19 @@ You don't even need to use the isSuccess flag.
1414
You can install @suspensive/react-query via [NPM](https://www.npmjs.com/package/@suspensive/react-query).
1515

1616
```bash
17-
$ npm i @suspensive/react-query
18-
# or
19-
$ pnpm add @suspensive/react-query
20-
# or
21-
$ yarn add @suspensive/react-query
17+
npm i @suspensive/react-query
18+
```
19+
20+
or
21+
22+
```bash
23+
pnpm add @suspensive/react-query
24+
```
25+
26+
or
27+
28+
```bash
29+
yarn add @suspensive/react-query
2230
```
2331

2432
### Motivation

docs/framework/react/devtools.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,19 @@ The devtools are a separate package that you need to install.
1818
The major version of all the packages must be in sync.
1919

2020
```bash
21-
$ npm i @tanstack/react-query-devtools@4
22-
# or
23-
$ pnpm add @tanstack/react-query-devtools@4
24-
# or
25-
$ yarn add @tanstack/react-query-devtools@4
21+
npm i @tanstack/react-query-devtools@4
22+
```
23+
24+
or
25+
26+
```bash
27+
pnpm add @tanstack/react-query-devtools@4
28+
```
29+
30+
or
31+
32+
```bash
33+
yarn add @tanstack/react-query-devtools@4
2634
```
2735

2836
You can import the devtools like this:

docs/framework/react/installation.md

Lines changed: 26 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,19 @@ or a good ol' `<script>` via
1010
### NPM
1111

1212
```bash
13-
$ npm i @tanstack/react-query
14-
# or
15-
$ pnpm add @tanstack/react-query
16-
# or
17-
$ yarn add @tanstack/react-query
13+
npm i @tanstack/react-query@4
14+
```
15+
16+
or
17+
18+
```bash
19+
pnpm add @tanstack/react-query@4
20+
```
21+
22+
or
23+
24+
```bash
25+
yarn add @tanstack/react-query@4
1826
```
1927

2028
React Query is compatible with React v16.8+ and works with ReactDOM and React Native.
@@ -53,9 +61,17 @@ Opera >= 53
5361
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:
5462

5563
```bash
56-
$ npm i -D @tanstack/eslint-plugin-query
57-
# or
58-
$ pnpm add -D @tanstack/eslint-plugin-query
59-
# or
60-
$ yarn add -D @tanstack/eslint-plugin-query
64+
npm i -D @tanstack/eslint-plugin-query@4
65+
```
66+
67+
or
68+
69+
```bash
70+
pnpm add -D @tanstack/eslint-plugin-query@4
71+
```
72+
73+
or
74+
75+
```bash
76+
yarn add -D @tanstack/eslint-plugin-query@4
6177
```

docs/framework/svelte/installation.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,19 @@ You can install Svelte Query via [NPM](https://npmjs.com).
88
### NPM
99

1010
```bash
11-
$ npm i @tanstack/svelte-query
12-
# or
13-
$ pnpm add @tanstack/svelte-query
14-
# or
15-
$ yarn add @tanstack/svelte-query
11+
npm i @tanstack/svelte-query
12+
```
13+
14+
or
15+
16+
```bash
17+
pnpm add @tanstack/svelte-query
18+
```
19+
20+
or
21+
22+
```bash
23+
yarn add @tanstack/svelte-query
1624
```
1725

1826
> Wanna give it a spin before you download? Try out the [basic](../examples/basic) example!

docs/framework/vue/installation.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,19 @@ You can install Vue Query via [NPM](https://npmjs.com).
88
### NPM
99

1010
```bash
11-
$ npm i @tanstack/vue-query
12-
# or
13-
$ pnpm add @tanstack/vue-query
14-
# or
15-
$ yarn add @tanstack/vue-query
11+
npm i @tanstack/vue-query
12+
```
13+
14+
or
15+
16+
```bash
17+
pnpm add @tanstack/vue-query
18+
```
19+
20+
or
21+
22+
```bash
23+
yarn add @tanstack/vue-query
1624
```
1725

1826
> Wanna give it a spin before you download? Try out the [basic](../examples/basic) example!

packages/vue-query/README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,19 @@ Visit https://tanstack.com/query/v4/docs/adapters/vue-query
3535
1. Install `vue-query`
3636

3737
```bash
38-
$ npm i @tanstack/vue-query
39-
# or
40-
$ pnpm add @tanstack/vue-query
41-
# or
42-
$ yarn add @tanstack/vue-query
38+
npm i @tanstack/vue-query
39+
```
40+
41+
or
42+
43+
```bash
44+
pnpm add @tanstack/vue-query
45+
```
46+
47+
or
48+
49+
```bash
50+
yarn add @tanstack/vue-query
4351
```
4452

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

0 commit comments

Comments
 (0)