Skip to content

Commit 639363c

Browse files
authoredAug 21, 2024
docs: make copyable example useful by default (#7928)
When copying the command, the $ appears in the copied text which makes a tiny text processing required - i.e removing the prefix. Instead of being able to just paste in a terminal and get going. This mimics the behaviour of all commands everywhere else in the docs I could find. e.g https://tanstack.com/query/latest/docs/framework/react/installation
1 parent 7ac71ac commit 639363c

File tree

4 files changed

+16
-16
lines changed

4 files changed

+16
-16
lines changed
 

‎docs/framework/angular/devtools.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,25 @@ title: Devtools
88
The devtools are a separate package that you need to install:
99

1010
```bash
11-
$ npm i @tanstack/angular-query-devtools-experimental
11+
npm i @tanstack/angular-query-devtools-experimental
1212
```
1313

1414
or
1515

1616
```bash
17-
$ pnpm add @tanstack/angular-query-devtools-experimental
17+
pnpm add @tanstack/angular-query-devtools-experimental
1818
```
1919

2020
or
2121

2222
```bash
23-
$ yarn add @tanstack/angular-query-devtools-experimental
23+
yarn add @tanstack/angular-query-devtools-experimental
2424
```
2525

2626
or
2727

2828
```bash
29-
$ bun add @tanstack/angular-query-devtools-experimental
29+
bun add @tanstack/angular-query-devtools-experimental
3030
```
3131

3232
You can import the devtools like this:

‎docs/framework/react/devtools.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -20,25 +20,25 @@ When you begin your React Query journey, you'll want these devtools by your side
2020
The devtools are a separate package that you need to install:
2121

2222
```bash
23-
$ npm i @tanstack/react-query-devtools
23+
npm i @tanstack/react-query-devtools
2424
```
2525

2626
or
2727

2828
```bash
29-
$ pnpm add @tanstack/react-query-devtools
29+
pnpm add @tanstack/react-query-devtools
3030
```
3131

3232
or
3333

3434
```bash
35-
$ yarn add @tanstack/react-query-devtools
35+
yarn add @tanstack/react-query-devtools
3636
```
3737

3838
or
3939

4040
```bash
41-
$ bun add @tanstack/react-query-devtools
41+
bun add @tanstack/react-query-devtools
4242
```
4343

4444
For Next 13+ App Dir you must install it as a dev dependency for it to work.

‎docs/framework/solid/devtools.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -12,25 +12,25 @@ When you begin your Solid Query journey, you'll want these devtools by your side
1212
The devtools are a separate package that you need to install:
1313

1414
```bash
15-
$ npm i @tanstack/solid-query-devtools
15+
npm i @tanstack/solid-query-devtools
1616
```
1717

1818
or
1919

2020
```bash
21-
$ pnpm add @tanstack/solid-query-devtools
21+
pnpm add @tanstack/solid-query-devtools
2222
```
2323

2424
or
2525

2626
```bash
27-
$ yarn add @tanstack/solid-query-devtools
27+
yarn add @tanstack/solid-query-devtools
2828
```
2929

3030
or
3131

3232
```bash
33-
$ bun add @tanstack/solid-query-devtools
33+
bun add @tanstack/solid-query-devtools
3434
```
3535

3636
You can import the devtools like this:

‎docs/framework/vue/devtools.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -15,25 +15,25 @@ Component-based devtools use a framework-agnostic implementation and are always
1515
The devtools component is a separate package that you need to install:
1616

1717
```bash
18-
$ npm i @tanstack/vue-query-devtools
18+
npm i @tanstack/vue-query-devtools
1919
```
2020

2121
or
2222

2323
```bash
24-
$ pnpm add @tanstack/vue-query-devtools
24+
pnpm add @tanstack/vue-query-devtools
2525
```
2626

2727
or
2828

2929
```bash
30-
$ yarn add @tanstack/vue-query-devtools
30+
yarn add @tanstack/vue-query-devtools
3131
```
3232

3333
or
3434

3535
```bash
36-
$ bun add @tanstack/vue-query-devtools
36+
bun add @tanstack/vue-query-devtools
3737
```
3838

3939
By default, Vue Query Devtools are only included in bundles when `process.env.NODE_ENV === 'development'`, so you don't need to worry about excluding them during a production build.

0 commit comments

Comments
 (0)
Please sign in to comment.