Skip to content

Commit bd6457b

Browse files
author
Dmitrii Troitskii
committed
docs(examples): move links outside code blocks in basic README
Markdown links inside fenced code blocks are rendered as raw text instead of clickable links. Move the 'global turbo' and filter links outside the code blocks so they render correctly when the starter README is copied to a new project. Closes #11945
1 parent 037b7ba commit bd6457b

File tree

1 file changed

+45
-21
lines changed

1 file changed

+45
-21
lines changed

examples/basic/README.md

Lines changed: 45 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -36,25 +36,33 @@ This Turborepo has some additional tools already setup for you:
3636

3737
To build all apps and packages, run the following command:
3838

39-
```
40-
cd my-turborepo
39+
With [global `turbo`](https://turborepo.dev/docs/getting-started/installation#global-installation) installed (recommended):
4140

42-
# With [global `turbo`](https://turborepo.dev/docs/getting-started/installation#global-installation) installed (recommended)
41+
```sh
42+
cd my-turborepo
4343
turbo build
44+
```
45+
46+
Without global `turbo`, use your package manager:
4447

45-
# Without [global `turbo`](https://turborepo.dev/docs/getting-started/installation#global-installation), use your package manager
48+
```sh
49+
cd my-turborepo
4650
npx turbo build
4751
yarn dlx turbo build
4852
pnpm exec turbo build
4953
```
5054

5155
You can build a specific package by using a [filter](https://turborepo.dev/docs/crafting-your-repository/running-tasks#using-filters):
5256

53-
```
54-
# With [global `turbo`](https://turborepo.dev/docs/getting-started/installation#global-installation) installed (recommended)
57+
With [global `turbo`](https://turborepo.dev/docs/getting-started/installation#global-installation) installed:
58+
59+
```sh
5560
turbo build --filter=docs
61+
```
62+
63+
Without global `turbo`:
5664

57-
# Without [global `turbo`](https://turborepo.dev/docs/getting-started/installation#global-installation), use your package manager
65+
```sh
5866
npx turbo build --filter=docs
5967
yarn exec turbo build --filter=docs
6068
pnpm exec turbo build --filter=docs
@@ -64,25 +72,33 @@ pnpm exec turbo build --filter=docs
6472

6573
To develop all apps and packages, run the following command:
6674

67-
```
68-
cd my-turborepo
75+
With [global `turbo`](https://turborepo.dev/docs/getting-started/installation#global-installation) installed (recommended):
6976

70-
# With [global `turbo`](https://turborepo.dev/docs/getting-started/installation#global-installation) installed (recommended)
77+
```sh
78+
cd my-turborepo
7179
turbo dev
80+
```
7281

73-
# Without [global `turbo`](https://turborepo.dev/docs/getting-started/installation#global-installation), use your package manager
82+
Without global `turbo`, use your package manager:
83+
84+
```sh
85+
cd my-turborepo
7486
npx turbo dev
7587
yarn exec turbo dev
7688
pnpm exec turbo dev
7789
```
7890

7991
You can develop a specific package by using a [filter](https://turborepo.dev/docs/crafting-your-repository/running-tasks#using-filters):
8092

81-
```
82-
# With [global `turbo`](https://turborepo.dev/docs/getting-started/installation#global-installation) installed (recommended)
93+
With [global `turbo`](https://turborepo.dev/docs/getting-started/installation#global-installation) installed:
94+
95+
```sh
8396
turbo dev --filter=web
97+
```
98+
99+
Without global `turbo`:
84100

85-
# Without [global `turbo`](https://turborepo.dev/docs/getting-started/installation#global-installation), use your package manager
101+
```sh
86102
npx turbo dev --filter=web
87103
yarn exec turbo dev --filter=web
88104
pnpm exec turbo dev --filter=web
@@ -97,13 +113,17 @@ Turborepo can use a technique known as [Remote Caching](https://turborepo.dev/do
97113

98114
By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can [create one](https://vercel.com/signup?utm_source=turborepo-examples), then enter the following commands:
99115

100-
```
101-
cd my-turborepo
116+
With [global `turbo`](https://turborepo.dev/docs/getting-started/installation#global-installation) installed (recommended):
102117

103-
# With [global `turbo`](https://turborepo.dev/docs/getting-started/installation#global-installation) installed (recommended)
118+
```sh
119+
cd my-turborepo
104120
turbo login
121+
```
122+
123+
Without global `turbo`, use your package manager:
105124

106-
# Without [global `turbo`](https://turborepo.dev/docs/getting-started/installation#global-installation), use your package manager
125+
```sh
126+
cd my-turborepo
107127
npx turbo login
108128
yarn exec turbo login
109129
pnpm exec turbo login
@@ -113,11 +133,15 @@ This will authenticate the Turborepo CLI with your [Vercel account](https://verc
113133

114134
Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your Turborepo:
115135

116-
```
117-
# With [global `turbo`](https://turborepo.dev/docs/getting-started/installation#global-installation) installed (recommended)
136+
With [global `turbo`](https://turborepo.dev/docs/getting-started/installation#global-installation) installed:
137+
138+
```sh
118139
turbo link
140+
```
119141

120-
# Without [global `turbo`](https://turborepo.dev/docs/getting-started/installation#global-installation), use your package manager
142+
Without global `turbo`:
143+
144+
```sh
121145
npx turbo link
122146
yarn exec turbo link
123147
pnpm exec turbo link

0 commit comments

Comments
 (0)